Link Search Menu Expand Document

Changelog

Date: Mar 8 2021

Commit: cfcd533

Added: vault/dendron.case-studies.md

Files changed (1) hide show
  1. vault/dendron.case-studies.md +11 -0
vault/dendron.case-studies.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 34ee4bcf-60e9-4031-a4c0-26113b5acb80
3
+ title: Case Studies
4
+ desc: ''
5
+ updated: 1596566527331
6
+ created: 1596566527331
7
+ stub: false
8
+ nav_order: 4.5
9
+ ---
10
+
11
+

Added: vault/dendron.case-studies.onboarding.md

vault/dendron.case-studies.onboarding.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ id: e8d6241e-1708-4bde-bd3d-93b440a1eaad
3
+ title: Dendron Onboarding
4
+ desc: ''
5
+ updated: 1598579955124
6
+ created: 1598579955124
7
+ stub: false
8
+ ---
9
+ For new users, I do an initial [onboarding](https://calendly.com/thence/dendron) session to help folks get started.
10
+
11
+ This is an example of an onboarding session.
12
+
13
+ <iframe width="560" height="315" src="https://www.youtube.com/embed/3io2fHRmZsE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
14
+

Added: vault/dendron.case-studies.para.md

Files changed (1) hide show
  1. vault/dendron.case-studies.para.md +16 -0
vault/dendron.case-studies.para.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 664c7980-f605-43ad-a931-c139740777c8
3
+ title: PARA
4
+ desc: ''
5
+ updated: 1597286900059
6
+ created: 1597286900059
7
+ stub: false
8
+ ---
9
+ PARA is a way of organizing all notes into four buckets. It's described [here](https://fortelabs.co/blog/para/).
10
+
11
+ This is a video of how you might apply PARA inside Dendron.
12
+
13
+ <a href="https://youtu.be/vrhBNGMJQwE">
14
+ <img src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/usecase-para.jpg"/>
15
+ </a>
16
+

Added: vault/dendron.cheatsheet.md

Files changed (1) hide show
  1. vault/dendron.cheatsheet.md +312 -0
vault/dendron.cheatsheet.md ADDED
@@ -0,0 +1,312 @@
1
+ ---
2
+ id: f9540bb6-7a5a-46db-ae7c-e1a606f28c73
3
+ title: 'Cheatsheet'
4
+ desc: ''
5
+ updated: 1596374871110
6
+ created: 1596374871110
7
+ nav_order: 8.5
8
+ ---
9
+
10
+ This is a cheatsheet for Dendron.
11
+
12
+ # Useful Links
13
+ - [Dendron Discord](https://discord.gg/6j85zNX): Get answers to all your questions here
14
+ - [Dendron Onboarding](https://calendly.com/thence/dendron): If you are a new user, [Kevin](http://kevinslin.com/), our founder, does a personal onboarding to help you setup your workspace. You can see an example of said onboarding [here](https://www.dendron.so/notes/e8d6241e-1708-4bde-bd3d-93b440a1eaad.html).
15
+ - [Github Issues](https://github.com/dendronhq/dendron/issues): If you found a bug or want to submit a feature request, you can file a ticket
16
+ - [Hierarchal First Approach to Note Taking](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html): An article about the principle that Dendron was built around
17
+ - [VSCode Keyboard Shortcuts](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference)
18
+
19
+ # Commands
20
+ ---
21
+ ## Lookup
22
+ ### Dendron: Contribute
23
+ - description: Become an environmentalist and keep Dendron sustainable
24
+ - shortcuts: none
25
+
26
+
27
+
28
+ ---
29
+ ## Notes
30
+ ### Dendron: Create Daily Journal Note
31
+ - description: Create a global journal note
32
+ - shortcuts:
33
+ - key: `ctrl+shift+i`
34
+ - mac: `cmd+shift+i`
35
+ - when: `editorFocus`
36
+
37
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
38
+
39
+ ### Dendron: Copy Note Link
40
+ - description: Copy wiki link to note
41
+ - shortcuts:
42
+ - key: `ctrl+shift+c`
43
+ - mac: `cmd+shift+c`
44
+ - when: `editorFocus`
45
+
46
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
47
+
48
+ ### Dendron: Copy Note Ref
49
+ - description: Copies a reference to the current open document
50
+ - shortcuts:
51
+ - key: `ctrl+shift+r`
52
+ - mac: `cmd+shift+r`
53
+ - when: `editorFocus`
54
+
55
+
56
+
57
+ ### Dendron: Delete Node
58
+ - description: Delete a note or schema
59
+ - shortcuts:
60
+ - key: `ctrl+shift+d`
61
+ - mac: `cmd+shift+d`
62
+
63
+
64
+
65
+ ### Dendron: Rename Note
66
+ - description: Rename a note and all backlinks
67
+ - shortcuts: none
68
+
69
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
70
+
71
+ ### Dendron: Show Preview
72
+ - description: Show Markdown Preview
73
+ - shortcuts:
74
+ - windows: `windows+ctrl+p`
75
+ - mac: `cmd+ctrl+p`
76
+
77
+
78
+
79
+ ---
80
+ ## Navigation
81
+ ### Dendron: Lookup
82
+ - description: Initiate note lookup
83
+ - shortcuts:
84
+ - mac: `cmd+L`
85
+ - key: `ctrl+l`
86
+
87
+
88
+
89
+ ### Dendron: Lookup (Journal Note)
90
+ - description: Initiate note lookup with journal note pre-selected
91
+ - shortcuts:
92
+ - key: `ctrl+shift+j`
93
+ - mac: `cmd+shift+j`
94
+ - args: `{'noteType': 'journal'}`
95
+
96
+
97
+
98
+ ### Dendron: Lookup (Scratch Note)
99
+ - description: Initiate note lookup with scratch note pre-selected
100
+ - shortcuts:
101
+ - key: `ctrl+shift+s`
102
+ - mac: `cmd+shift+s`
103
+ - args: `{'noteType': 'scratch', 'selectionType': 'selection2link'}`
104
+
105
+
106
+
107
+ ### Dendron: Lookup Schema
108
+ - description: Initiate schema lookup
109
+ - shortcuts:
110
+ - mac: `cmd+shift+L`
111
+ - key: `ctrl+shift+l`
112
+
113
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
114
+
115
+ ### Dendron: Open Link
116
+ - description: Open link to external file (eg. pdf, .mov, etc) use system default
117
+ - shortcuts: none
118
+
119
+ <a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
120
+
121
+ ---
122
+ ## Hierarchies
123
+ ### Dendron: Reload Index
124
+ - description: Reload the index. Necessary for Dendron to pick up on schema changes.
125
+ - shortcuts: none
126
+
127
+
128
+
129
+ ### Dendron: Archive Hierarchy
130
+ - description: Move current note and all children under the `archive` hierarchy
131
+ - shortcuts: none
132
+
133
+ <a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
134
+
135
+ ### Dendron: Refactor Hierarchy
136
+ - description: Update hierarchy using regex
137
+ - shortcuts: none
138
+
139
+ <a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
140
+
141
+ ### Dendron: Go Up
142
+ - description: Go to closet non-stub parent of the currently open note
143
+ - shortcuts:
144
+ - mac: `cmd+shift+up`
145
+ - key: `ctrl+shift+up`
146
+ - when: `editorFocus`
147
+
148
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
149
+
150
+ ### Dendron: Go Next Sibling
151
+ - description: Go to the next sibling
152
+ - shortcuts:
153
+ - key: `ctrl+shift+]`
154
+ - when: `editorFocus`
155
+
156
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
157
+
158
+ ### Dendron: Go Previous Sibling
159
+ - description: Go to the previous sibling
160
+ - shortcuts:
161
+ - key: `ctrl+shift+[`
162
+ - when: `editorFocus`
163
+
164
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
165
+
166
+ ### Dendron: Go Down
167
+ - description: Go down the hierarchy
168
+ - shortcuts:
169
+ - mac: `cmd+shift+down`
170
+ - key: `ctrl+shift+down`
171
+ - when: `editorFocus`
172
+
173
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
174
+
175
+ ---
176
+ ## Workspace
177
+ ### Dendron: Vault Add
178
+ - description: Add a new vault
179
+ - shortcuts: none
180
+
181
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
182
+
183
+ ### Dendron: Vault Remove
184
+ - description: Remove a vault
185
+ - shortcuts: none
186
+
187
+ Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
188
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
189
+
190
+ ### Dendron: Initialize Workspace
191
+ - description: Create a new workspace
192
+ - shortcuts: none
193
+
194
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workspace-init.gif)
195
+
196
+ ### Dendron: Change Workspace
197
+ - description: Change into existing workspace
198
+ - shortcuts: none
199
+
200
+
201
+
202
+ ### Dendron: Snapshot Vault
203
+ - description: Create a snapshot of your vault
204
+ - shortcuts: none
205
+
206
+
207
+
208
+ ### Dendron: Restore Vault
209
+ - description: Restore your vault from a snapshot
210
+ - shortcuts: none
211
+
212
+
213
+
214
+ ### Dendron: Show Help
215
+ - description: Dendron will open your current browser to the [[cheatsheet|dendron.cheatsheet]] page.
216
+ - shortcuts: none
217
+
218
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
219
+
220
+ ### Dendron: Configure (yaml)
221
+ - description: Modify Dendron Config as raw YAML
222
+ - shortcuts: none
223
+
224
+
225
+
226
+ ### Dendron: Configure
227
+ - description: Modify Dendron Config using Dendron UI
228
+ - shortcuts: none
229
+
230
+
231
+
232
+ ---
233
+ ## Pods
234
+ ### Dendron: Build Pod
235
+ - description: Build your notes for export. Currently, only export to github pages is supported.
236
+ - shortcuts: none
237
+
238
+
239
+
240
+ ### Dendron: Configure Pod
241
+ - description: Update your pod configuration
242
+ - shortcuts: none
243
+
244
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.configure.gif)
245
+
246
+ ### Dendron: Import Pod
247
+ - description: Import notes from an external data source. Currently, only the local file system is supported
248
+ - shortcuts: none
249
+
250
+
251
+
252
+ ### Dendron: Export Pod
253
+ - description: Export notes to an external data source. Currently only JSON is supported.
254
+ - shortcuts: none
255
+
256
+ <a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
257
+
258
+ ### Dendron: Publish Pod
259
+ - description: Publish your note to a different format/location
260
+ - shortcuts: none
261
+
262
+
263
+
264
+ ### Dendron: Copy Note URL
265
+ - description: Get URL of current note from published site
266
+ - shortcuts:
267
+ - mac: `cmd+shift+u`
268
+ - windows: `ctrl+shift+u`
269
+
270
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.copy-url.gif)
271
+
272
+ ---
273
+ ## Publishing
274
+ ### Dendron: Publish
275
+ - description: Build, commit and publish your notes with a single command
276
+ - shortcuts: none
277
+
278
+ <a href="https://www.loom.com/share/c58edf543e234a8fa164095237579ccc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c58edf543e234a8fa164095237579ccc-with-play.gif"> </a>
279
+
280
+ ### Dendron: Site Build
281
+ - description: Build your notes using publishing v2
282
+ - shortcuts: none
283
+
284
+
285
+
286
+ ### Dendron: Site Preview
287
+ - description: Preview your notes on localhost using publishing v2
288
+ - shortcuts: none
289
+
290
+
291
+
292
+ ---
293
+ ## Dev
294
+ ### Dendron: Doctor
295
+ - description: Auto fix issues with frontmatter
296
+ - shortcuts: none
297
+
298
+ <a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif"> </a>
299
+
300
+ ### Dendron: Dump State
301
+ - description: Dump internal state of Dendron inside logs
302
+ - shortcuts: none
303
+
304
+
305
+
306
+ ### Dendron:Dev: Open Logs
307
+ - description: Open Dendron logs for current session
308
+ - shortcuts: none
309
+
310
+
311
+
312
+

Added: vault/dendron.community.md

Files changed (1) hide show
  1. vault/dendron.community.md +10 -0
vault/dendron.community.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 6f4cd441-f883-4e75-871b-b7f93895c91b
3
+ title: Community
4
+ desc: ''
5
+ updated: 1607965800209
6
+ created: 1604236612582
7
+ nav_order: 2.2
8
+ ---
9
+ Dendron wouldn't be what it is today without its wonderful users.
10
+

Added: vault/dendron.community.roles.md

Files changed (1) hide show
  1. vault/dendron.community.roles.md +38 -0
vault/dendron.community.roles.md ADDED
@@ -0,0 +1,38 @@
1
+ ---
2
+ id: 7c00d606-7b75-4d28-b563-d75f33f8e0d7
3
+ title: Roles
4
+ desc: ''
5
+ updated: 1605552659231
6
+ created: 1604237102230
7
+ ---
8
+ Dendron has special roles for members of its community.
9
+
10
+ ## Dendrologist
11
+
12
+ **Dendrologist** are active members of the Dendron community. They play a vital role in helping new members get started and setting best practices for Dendron and its community.
13
+
14
+ Dendrologist help shape Dendron's roadmap and community standards. They also gain additional discord super powers like creating channels, pinning messages, and other moderation capabilities.
15
+
16
+ ## Environmentalist
17
+
18
+ **Environmentalist** are members that show their support by making monthly [financial contributions](https://accounts.dendron.so/account/subscribe) to Dendron.
19
+
20
+ Environmentalist get a special discord role, early access to new features,
21
+ special channels, and other goodies.
22
+
23
+ ## Horticulturalist
24
+
25
+ **Horticulturalist** are members who have contributed to the Dendron code base.
26
+
27
+ ## Taxonomist
28
+
29
+ A **Taxonomist** is a member who improved the Dendron documentation.
30
+
31
+ ## Planter
32
+
33
+ A **Planter** is a member who published their notes using Dendron
34
+
35
+ ## Bug Catcher
36
+
37
+ A **Bug Catcher** is a member who found a reproducible bug in Dendron.
38
+

Added: vault/dendron.community.showcase.md

Files changed (1) hide show
  1. vault/dendron.community.showcase.md +78 -0
vault/dendron.community.showcase.md ADDED
@@ -0,0 +1,78 @@
1
+ ---
2
+ id: 3a82c5ff-7945-46ae-8bf9-3b2275fc6642
3
+ title: Showcase
4
+ desc: ''
5
+ updated: 1614059886015
6
+ created: 1600010740851
7
+ ---
8
+ Below are examples of published Dendron vaults
9
+
10
+ ## Official
11
+
12
+ ### Dendron homepage
13
+
14
+ - homepage: <https://dendron.so>
15
+ ![](/assets/images/2020-09-13-09-05-45.png)
16
+
17
+ ### Open PKM Catalogue
18
+
19
+ - homepage: <https://pkm.dendron.so>
20
+
21
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/showcase.pkm.jpg)
22
+
23
+ ### Open AWS Catalogue
24
+
25
+ - homepage: <https://aws.dendron.so>
26
+
27
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/showcase.aws.jpg)
28
+
29
+ ## Members
30
+
31
+ ### Kevin's page
32
+
33
+ - homepage: <https://kevinslin.com/>
34
+ - discord: `@kevins8#0590`
35
+ ![](/assets/images/2020-09-13-08-45-00.png)
36
+
37
+ ### Ed's Page
38
+
39
+ - homepage: <https://ens100.github.io/>
40
+ - discord: `@edns100#4851`
41
+
42
+ ![](/assets/images/2020-09-13-09-04-36.png)
43
+
44
+ ### Jack's page
45
+
46
+ - homepage: <https://imalightbulb.xyz>
47
+ - discord: `@I'm a lightbulb#6986`
48
+
49
+ ![](/assets/images/2020-09-13-09-01-48.png)
50
+
51
+ ### Luke's second brain
52
+
53
+ - homepage: <https://luke.carrier.im/>
54
+ - discord: `@lukecarrier#2081`
55
+
56
+ ![](/assets/images/2020-09-27-20-50-54.png)
57
+
58
+ ### Ian's digital garden
59
+
60
+ - homepage: <https://garden.ianjones.us/>
61
+ - discord: `@ianjones#3696`
62
+
63
+ ![](/assets/images/2020-12-06-09-43-31.png)
64
+
65
+ ### Kevin's digital garden (another one)
66
+
67
+ - homepage: garden.kevincunningham.co.uk
68
+ - discord: `@dolearning (Kevin)#3551`
69
+
70
+ ![ScreenShot of @dolearning digital garden](https://res.cloudinary.com/kc-cloud/image/upload/v1607614868/digital_garden_screenshot_j9wrcz.png)
71
+
72
+
73
+ ### Cameron's digital garden
74
+
75
+ - homepage: <https://notes.serendipidata.com/>
76
+ - discord: `@cameron#9185`
77
+
78
+ ![](https://p-qkfgo2.t2.n0.cdn.getcloudapp.com/items/WnuBJ0L1/8befb6dd-740d-4088-bbeb-b5c21954e308.jpg?v=4e54f3d2ffbbe051c195eab04c72971f)

Added: vault/dendron.concepts.md

Files changed (1) hide show
  1. vault/dendron.concepts.md +136 -0
vault/dendron.concepts.md ADDED
@@ -0,0 +1,136 @@
1
+ ---
2
+ id: c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50
3
+ title: Concepts
4
+ desc: ''
5
+ updated: 1614057298609
6
+ created: 1595169512265
7
+ nav_order: 3
8
+ ---
9
+
10
+ Below are some concepts that are helpful to know when using Dendron. Note that features with 🚧 are still under active development and might not be fully implemented.
11
+
12
+ ### Markdown
13
+
14
+ Dendron supports markdown, a popular markup syntax that is like HTML but 1000x simpler. If you are new to markdown, you can read about the syntax [here](https://docs.gitbook.com/editing-content/markdown).
15
+
16
+ ### Frontmatter
17
+
18
+ Frontmatter is a convenient way of adding extra information to your documents like a shorthand title or longer description (think any extra information you can use to describe a note). This type of information is generally called metadata and the structure used is called [YAML](https://yaml.org/). You can add it to the front of your markdown file and it won't show up in the preview. It was first introduced by [jekyll](https://jekyllrb.com/docs/front-matter/).
19
+
20
+ You can read more about the frontmatter used in Dendron [[here |dendron.topic.frontmatter]]
21
+
22
+ ### Workspace
23
+ In Dendron, your **workspace** is the root of where all your files are located. It's set when you first run `Dendron: Initialize Workspace`. The folder that contains your workspace is also known as your **workspace root**.
24
+
25
+ ### Vaults
26
+ Your workspace is made up of **vaults**. A dendron vault stores a collection of related notes. If you're familiar with git, it's just like a code repo. By default, Dendron creates a *vaults* folder when you first initialize a **workspace**. All your notes are stored on a per vault basis.
27
+
28
+ ```
29
+ .
30
+ └── workspace
31
+ ├── vault.main
32
+ │ ├── foo.md
33
+ │ ├── foo.one.md
34
+ │ └── foo.two.md
35
+ └── vault.secret (hypothetical)
36
+ ├── secret.one.md
37
+ └── secret.two.md
38
+ ```
39
+
40
+ By default, when you look for notes in Dendron, it will search over all vaults.
41
+
42
+ A vault can be one of two types:
43
+ - local
44
+ - remote
45
+
46
+ #### Local Vault
47
+
48
+ A local vault is what you start off with. Its a vault that is local to your file system.
49
+
50
+ #### Remote Vault
51
+
52
+ A remote vault is what you get when you run the [[Vault Add|dendron.topic.commands#vault-add]] command and select a remote vault. This is a vault that is cloned from a git repo.
53
+
54
+ <!--
55
+ ### Workspace Configuration
56
+ Workspace configuration is located directly underneath the **workspace root**. By convention, the default configuration is going to be in a folder titled **config**. This is also called the **configuration root**. A workspace can have multiple configurations that initializes your workspace with a different subset of vaults.
57
+ -->
58
+
59
+ ### Hierarchies
60
+
61
+ ((ref:[[dendron.topic.hierarchies]]#Hierarchies,1:#Concepts))
62
+
63
+ You can read more about hierarchies [[here|dendron.topic.hierarchies]]
64
+
65
+ ### Domain
66
+
67
+ A domain is the root of a hierarchy. In the example below, `project1` would be the domain.
68
+
69
+
70
+ ```
71
+ .
72
+ ├── project1.md
73
+ ├── project1.designs.md
74
+ ├── project1.designs.promotion.md
75
+ ├── project1.paperwork.md
76
+ ├── project1.paperwork.legal.md
77
+ ├── project1.tasks.md
78
+ ├── project1.tasks.task1.md
79
+ └── project1.tasks.task2.md
80
+ ```
81
+
82
+ ### Schema
83
+
84
+ As you end up creating more notes, it can be hard to keep track of it all. This is why Dendron has **schemas** to help you manage your notes. Think of schemas as an **optional type system** for your information. They describe the hierarchy of your notes and are themselves, represented as a hierarchy.
85
+
86
+ You can create a schema by adding a YAML file with the following naming scheme `{name}.schema.yml` to your workspace.
87
+
88
+ Below is an example of a three-level hierarchy describing cli commands. You don't need to concern yourself with the details of the schema syntax just yet, just know that this schema will match the following [glob patterns](https://facelessuser.github.io/wcmatch/glob/): `cli.*`, `cli.*.cmd`, `cli.*.cmd.*`, `cli.*.env`
89
+
90
+ ```yml
91
+ - id: cli
92
+ desc: command line interface reference
93
+ parent: root
94
+ namespace: true
95
+ children cmd
96
+ - env
97
+ - id: env
98
+ desc: variables relevant for command
99
+ - id: cmd
100
+ desc: subcommands
101
+ namespace: true
102
+ ```
103
+
104
+ ### Stubs
105
+
106
+ Stubs are notes that don't exist but that you might want to create. They will show up as suggestions in lookup results.
107
+ There are two reasons why these suggested notes might show up:
108
+ - they are the uncreated parent of a note deeper in the hierarchy (eg. `foo.bar` might be a stub for `foo.bar.foobar`)
109
+ - they are possible notes according to the schema
110
+
111
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-plus.jpg)
112
+ > The `+` sign next to the suggestion indicates that the note is a stub and does not exist
113
+
114
+ ### Pods
115
+
116
+ [[Pods |dendron.topic.pod]] are the mechanisms Dendron uses to import and export notes. Dendron has a different pod depending on where you are getting and publishing your data to.
117
+
118
+
119
+ ### Command Bar
120
+
121
+ The command bar is native to `vscode`. You can use it to run dendron commands, which will all be prefixed with `Dendron:`. You can use the following shortcut to open the command bar.
122
+
123
+ - <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+Shift+P`
124
+ - <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Cmd+Shift+P`
125
+ - <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `Ctrl+Shift+P`
126
+
127
+
128
+ ### Lookup Bar
129
+
130
+ The lookup bar is how you interact with notes inside of Dendron. Use it to create, find, and delete notes. You can type `> Dendron: Lookup` in the `Command Bar` or use the `Ctrl+L` shortcut.
131
+
132
+ - <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+L`
133
+ - <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Cmd+L`
134
+ - <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `Ctrl+L`
135
+
136
+ ![](assets/2020-07-07-20-14-57.png)

Added: vault/dendron.contribute.dev.md

Files changed (1) hide show
  1. vault/dendron.contribute.dev.md +50 -0
vault/dendron.contribute.dev.md ADDED
@@ -0,0 +1,50 @@
1
+ ---
2
+ id: 81da87be-2d4e-47b5-a1d6-c0d647e1ab00
3
+ title: Development
4
+ desc: ''
5
+ updated: 1614811289748
6
+ created: 1604236041570
7
+ ---
8
+
9
+ ## Summary
10
+ If you would like to contribute to the development of dendron, checkout out the [repo](https://github.com/dendronhq/dendron) from github.
11
+
12
+ You can then follow the [[setup instructions|dendron.dev.setup#getting-started]].
13
+
14
+ - NOTE: the above setup instructions are for the dendron plugin. See the below links if you are working on a different part of Dendron:
15
+ - [[Markdown Preview|dendron.pro.dendron-preview.setup]]
16
+ - [[Markdown Links|dendron.pro.markdown-links.setup]]
17
+
18
+ A great place to start is with issues labelled with the [size.small label](https://github.com/dendronhq/dendron/labels/size.small) on github. These are items that we picked out specifically for first time contributors and are small self contained task that are well suited for first time contributors.
19
+
20
+ Leave a comment in the issue if you decide to work on it. Issues that are being worked on will have the [status.wip label](https://github.com/dendronhq/dendron/labels/status.wip).
21
+
22
+ Remember that you are always welcome to ask for help inside the [#dev discord channel](https://discord.gg/AE3NRw9).
23
+
24
+ ![[dendron.journal.2021.02.20.migration]]
25
+
26
+ ## VSCode Extension Development
27
+
28
+ If you're not familiar with VSCode Extension Development, have no fear. There are lots of great resources for that.
29
+
30
+ The VSCode guide to [making your first extension](https://code.visualstudio.com/api/get-started/your-first-extension) is a great place to start.
31
+
32
+ Afterwards, you can see how specific features are implemented through the [vscode extension samples library](https://github.com/microsoft/vscode-extension-samples).
33
+
34
+ ## Pull Request Checklist
35
+
36
+ - [ ] add a [[test|dendron.dev.testing#writing-tests]] for the new feature
37
+ - [ ] make sure all the existing [[tests|dendron.dev.testing#running-all-tests]] pass
38
+ - [ ] if its your first pull request to Dendron, watch out for the [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) bot that will ask you to agree to Dendron's CLA
39
+ - [ ] if its your first pull request and you're on our Discord, make sure that Kevin gives you the [[horticulturalist|dendron.community.roles#horticulturalist]] role 👨‍🌾👩‍🌾
40
+
41
+
42
+ ## Commit Style
43
+
44
+ - we follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) with the following tags
45
+ - categories:
46
+ - feat: feature - introduce new functionality
47
+ - enhance: enhancement - improve existing functionality
48
+ - fix: make something not broken
49
+ - chore: backend improvements
50
+ - spike: not complete commit

Added: vault/dendron.contribute.documentation.md

vault/dendron.contribute.documentation.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: b58801fc-43a9-4d42-a58b-eabc3e8538cb
3
+ title: Documentation
4
+ desc: ''
5
+ updated: 1612846119097
6
+ created: 1604235766390
7
+ ---
8
+
9
+ ## Summary
10
+ If you would like to contribute to the docs, you can do so by either making changes on github directly or by cloning our website repo and sending us a pull request.
11
+
12
+ ### Making Changes on Github
13
+
14
+ Click `Edit this page on github` at the bottom left corner of every page. This is recommended way of making a change. The only pre-requisite is that you have a [github](https://github.com/) account.
15
+ <a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
16
+
17
+ Images
18
+ - if you're adding an image along with the documentation, you can [imgur](https://imgur.com/upload) to upload
19
+ - note that you'll want to copy the **image link** and not the link to the imgur website
20
+
21
+ <a href="https://www.loom.com/share/1b351d229eba4536a6361e5123cf8f24"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/1b351d229eba4536a6361e5123cf8f24-with-play.gif"> </a>
22
+
23
+ Gifs
24
+ - uploading gifs is the same process as uploading images
25
+ - to create gifs, we recommend using the [Kap](https://getkap.co/) app or making a [Loom video](http://loom.com/)
26
+ - if you are making a gif from within vscode, please turn on [screencast mode](https://scotch.io/bar-talk/vs-code-screencast-mode) so we can see what awesome keyboard shortcuts you're using :)
27
+
28
+ ### Making Changes via Pull Request
29
+
30
+ For more involved changes, you can clone our github [repo](https://github.com/dendronhq/dendron-template) and opening `dendron.code-workspace` using VSCode. [Dendron.so](https://www.dendron.so) is built from the contents of `vault/dendron.*`. Make a change in the corresponding file and send us a pull request to update the documentation. You can preview your changes using the `Dendron Markdown Enhanced` extension.

Added: vault/dendron.contribute.financial.md

vault/dendron.contribute.financial.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: abda4d2a-d8a2-4dd6-8ea0-4a5661fa13c1
3
+ title: Financial
4
+ desc: ''
5
+ updated: 1604236474623
6
+ created: 1604236189356
7
+ ---
8
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/grow-covid-2.png)
9
+
10
+ If you would like to make a financial contribution to Dendron, you can do so by getting a Dendron **environmentalist** subscription.
11
+
12
+ Environmentalists are special members of our community that help to keep Dendron sustainable. They get access to early builds, priority support, and access to our dev channel.
13
+
14
+ You can sign up to be an environmentalist [here](https://accounts.dendron.so/account/subscribe).
15
+

Added: vault/dendron.contribute.first-dev.md

vault/dendron.contribute.first-dev.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: 70b4a93a-c7e0-4e1c-a873-3a9a291f5248
3
+ title: First Time Developers
4
+ desc: ''
5
+ updated: 1605761135508
6
+ created: 1605760540330
7
+ ---
8
+ If you are interested in contributing to Dendron but haven't spent your career doing software, worry not. This is definitely something you can 🌱 into.
9
+
10
+ We have lots of resources to help you make your first contribution.
11
+
12
+ If you are completely new to software development, I would encourage you to look at the following resources:
13
+
14
+ - primer to typescript (everything in Dendron is based on this): <https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html>
15
+ - go through the javascript course: <https://www.codecademy.com/learn/introduction-to-javascript>
16
+
17
+ When you are ready to make a contribution, you can follow the instructions in the [[development page|dendron.contribute.dev]]
18
+
19
+ I'm also planning on streaming some dendron development on twitch in the coming weeks to show my workflow for working with Dendron and will give you a heads up when I'm doing them.
20
+

Added: vault/dendron.contribute.md

Files changed (1) hide show
  1. vault/dendron.contribute.md +29 -0
vault/dendron.contribute.md ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ id: 125c990b-6fe7-4ada-a65f-44cbde8b33f0
3
+ title: Contribute
4
+ desc: ''
5
+ updated: 1612846152764
6
+ created: 1596817278150
7
+ stub: false
8
+ nav_order: 9.5
9
+ toc: true
10
+ ---
11
+ ## Table of Contents
12
+
13
+ ## Development
14
+
15
+
16
+ ![[dendron.contribute.dev#summary,1:#*]]
17
+
18
+ ### First Time Developers
19
+
20
+ ![[dendron.contribute.first-dev]]
21
+
22
+ ## Documentation
23
+
24
+ ![[dendron.contribute.documentation#summary,1:#*]]
25
+
26
+ ## Financially
27
+
28
+ ![[dendron.contribute.financial]]
29
+

Added: vault/dendron.dev.api.md

Files changed (1) hide show
  1. vault/dendron.dev.api.md +10 -0
vault/dendron.dev.api.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 348fc5c7-e1ba-4fa2-ab6d-a3c94628fa11
3
+ title: API
4
+ desc: ''
5
+ updated: 1600376820065
6
+ created: 1600376820065
7
+ stub: false
8
+ ---
9
+
10
+

Added: vault/dendron.dev.api.seeds.md

Files changed (1) hide show
  1. vault/dendron.dev.api.seeds.md +16 -0
vault/dendron.dev.api.seeds.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 08a917a9-31f1-434d-bc7f-71dce2b63a27
3
+ title: Seeds
4
+ desc: ''
5
+ updated: 1600376826105
6
+ created: 1600376826105
7
+ stub: false
8
+ ---
9
+ ((ref:[[dendron.topic.seeds]]#seeds 🚧,1:#*))
10
+
11
+ # DendronSeed
12
+
13
+ Base class to extend from when creating a new seed. Documentation is still under construction. In the meanwhile, you can use [the code](https://github.com/dendronhq/dendron/blob/master/packages/seeds-core/src/base.ts#L39) as a guide when creating a new seed.
14
+
15
+ You can see an example of a seed implementation [here](https://github.com/dendronhq/seeds.aws/blob/master/packages/awsgeek-seed/src/index.ts#L63:L63)
16
+

Added: vault/dendron.dev.cook.md

Files changed (1) hide show
  1. vault/dendron.dev.cook.md +72 -0
vault/dendron.dev.cook.md ADDED
@@ -0,0 +1,72 @@
1
+ ---
2
+ id: a80f36d9-01d0-4c5a-a228-867b093a4913
3
+ title: Cookbook
4
+ desc: ''
5
+ updated: 1614811373375
6
+ created: 1599151918645
7
+ stub: false
8
+ ---
9
+ ### Install a new package
10
+
11
+ Because Dendron is packaged as a mono repo managed using [lerna](https://github.com/lerna/lerna), you can't just do a regular `yarn add` to install new packages. This is because lerna symlinks mono-repo dependencies together and a `yarn add` would override that. Instead, use the following command:
12
+
13
+ ```
14
+ lerna add {package-to-install} --scope @dendronhq/{package-to-install-into}
15
+ ```
16
+
17
+ Because this is typescript, don't forget to also install the `@types` package if it exists
18
+
19
+ ```bash
20
+ lerna add @types/{package-to-install} --scope @dendronhq/{package-to-install-into}
21
+ ```
22
+
23
+ ### Add a new node package
24
+
25
+ - initialize repo
26
+
27
+ ```bash
28
+ cd {workspace_dir}
29
+ cp -R /path/to/dendron-yeoman/node-ts packages/{new-package}
30
+ ```
31
+
32
+ - update `package.json`
33
+
34
+ - change project name
35
+
36
+ - publish the repo (needs to be done initially before running lerna publish)
37
+
38
+ ```
39
+ npm publish --access public
40
+ ```
41
+
42
+ ### Using eslint
43
+
44
+ All packages in the repo use a standard base configuration found at [.eslintrc.js](.eslintrc.js). If you're using the VS Code and would like to see eslint violations on it, install the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
45
+
46
+ ### Add a new site config option
47
+
48
+ The following is an example of controlling formatting options to the DendronSiteConfig. You can see the [issue](https://github.com/dendronhq/dendron/issues/278) for more details.
49
+
50
+ Dendron currently will auto-format notes during `Rename` and `Refactor` operations when links inside a note need to be replaced.
51
+
52
+ The formatting options are defined [here](https://dendron.so/notes/849ee8ee-05a5-47bf-b44d-d7c257117bc4.html#renaming-a-note).
53
+
54
+ These are [rough notes](https://dendron.so/notes/849ee8ee-05a5-47bf-b44d-d7c257117bc4.html#flow) of how formatting gets called during rename
55
+
56
+ To make this customizable, the following changes need to be made:
57
+
58
+ - [ ] update the [DendronConfig type definition](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L405:L405)
59
+ - [ ] update [config defaults](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/config.ts#L42:L42)
60
+ - [ ] pass in formatting options from the [plugin](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/RenameNoteV2a.ts#L137:L137)
61
+ - [ ] accept formatting args in the [server](https://github.com/dendronhq/dendron/blob/master/packages/api-server/src/routes/note.ts#L38:L38)
62
+ - [ ] accept formatting args in the [engine](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/enginev2.ts#L249:L249)
63
+ - [ ] accept it when [replacing links](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/topics/markdown/utilsv2.ts#L85:L85)
64
+ - [ ] accept it in [remark pipeline](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/topics/markdown/utilsv2.ts#L41:L41)
65
+
66
+ When all this is done, we can add tests that the formatting behavior works
67
+
68
+ - [ ] [engine tests](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/__tests__/enginev2.spec.ts#L652:L652)
69
+ - [ ] [plugin test](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/suite-integ/RenameNoteV2.test.ts#L157:L157)
70
+
71
+ The above changes are for `Rename`. `Refactor` calls rename in a loop so changing rename should update refactor as well.
72
+

Added: vault/dendron.dev.debug.md

Files changed (1) hide show
  1. vault/dendron.dev.debug.md +53 -0
vault/dendron.dev.debug.md ADDED
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: b239c77e-52f2-4cc3-8390-69e0bc776a72
3
+ title: Debugging
4
+ desc: ''
5
+ updated: 1607366232319
6
+ created: 1598653859135
7
+ stub: false
8
+ ---
9
+ ## Plugin
10
+
11
+ - run extension
12
+ - launch the `Run Extnesion` build task (copied below for reference)
13
+
14
+ ```json
15
+ {
16
+ "name": "Run Extension",
17
+ "type": "extensionHost",
18
+ "request": "launch",
19
+ "runtimeExecutable": "${execPath}",
20
+ "args": [
21
+ "--disable-extensions",
22
+ "--extensionDevelopmentPath=${workspaceFolder}"
23
+ ],
24
+ "outFiles": [
25
+ "${workspaceFolder}/out/**/*.js"
26
+ ],
27
+ "env": {
28
+ "STAGE": "dev",
29
+ "VSCODE_DEBUGGING_EXTENSION": "dendron"
30
+ }
31
+ },
32
+ ```
33
+
34
+ ### Breakpoints
35
+
36
+ Note that we currently have trouble setting breakpoints inside non-plugin code. That goes for the packages that Dendron depends on (eg. @dendronhq/common-all). The current workaround is to manually add a `debugger;` statement inside the code. The extension will hit it when restarted under the debugger.
37
+
38
+ ### Verbose Logs
39
+
40
+ - set in `dendorn.workspace.config`
41
+
42
+ ```json
43
+ "dendron.logLevel": "debug",
44
+ ```
45
+
46
+ ## Server
47
+
48
+ Normally, Dendron will launch an express server at a random port. To debug the server:
49
+
50
+ 1. Launch the server using the build task `api-server:test launch server`
51
+ 2. Update the workspace settings of Dendron to use a running server through the following workspace setting `dendron.serverPort": 3005`
52
+ 3. Reload the workspace for the settings to take affect
53
+

Added: vault/dendron.dev.design.commands.md

vault/dendron.dev.design.commands.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: fc73e5c7-d0fa-43d3-9c45-943c67d8afdb
3
+ title: Commands
4
+ desc: ''
5
+ updated: 1603668197282
6
+ created: 1599360021856
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.dev.design.commands.rename.md

vault/dendron.dev.design.commands.rename.md ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ id: 9bcb030d-3e8e-4173-85fb-846b3c3bc83a
3
+ title: Rename
4
+ desc: ''
5
+ updated: 1606863442772
6
+ created: 1598917863248
7
+ stub: false
8
+ ---
9
+
10
+ ## Summary
11
+
12
+ ## Flows
13
+
14
+ - loc: plugin-core/src/commands/RenameNoteV2.ts
15
+ ```ts
16
+ ...
17
+ allUris = getWorkspaceCache.allUris + files.map{ f => f.newUri }
18
+ newUris = allUris
19
+
20
+ ```
21
+
22
+ -
23
+ ```ts
24
+ getWorkspaceCache {
25
+
26
+ }
27
+
28
+ cacheUris {
29
+ markdownUris = DendronWorkspace.instance().engine.notes
30
+ }
31
+ ```

Added: vault/dendron.dev.design.engine.md

Files changed (1) hide show
  1. vault/dendron.dev.design.engine.md +359 -0
vault/dendron.dev.design.engine.md ADDED
@@ -0,0 +1,359 @@
1
+ ---
2
+ id: 849ee8ee-05a5-47bf-b44d-d7c257117bc4
3
+ title: Summary
4
+ desc: ''
5
+ updated: 1605287509430
6
+ created: 1598652399447
7
+ stub: false
8
+ ---
9
+ These documents are a high level overview of the code inside Dendron. They are written in a type script like pseudo code. The code blocks are broken down into the following structure:
10
+
11
+ ```
12
+ # {Function} --> what is happening
13
+ ## Summary --> high level function call of what is happening
14
+ ## Flows --> pseudo code describing high level functions
15
+
16
+ ### {Flow Entry}
17
+
18
+ - loc: ... --> where code is located. {package}/{basename}
19
+ - desc: ... --> description
20
+ ```
21
+
22
+ ## Pseudo Code
23
+
24
+ The code description is typescript-ish. The goal isn't to write valid typescript but be a **summarized** version of the code. The syntax is evolving but here is a loosely documented starting point:
25
+
26
+ - @: equivalent of `this.`
27
+ - $: referencing a global variable
28
+ - `...`: code that is omitted because it would clutter the summary
29
+ - `=:` magic equality,
30
+
31
+ The places where you see this convention being broken (eg. actual valid typescript) are areas where the author got lazy and just copied code into the summary. Try to not do this because that defeats the point of a _summarized_ view. That being said, Dendron is all about being pragmatic and taking an iterative approach to things.
32
+
33
+ # Initializing the Engine
34
+
35
+ ## Summary
36
+
37
+ - engine.query
38
+ - store.query
39
+ - FileParser.parse
40
+ ```ts
41
+ allFiles {
42
+ getFileMeta
43
+ toNode
44
+ }
45
+ ```
46
+ - NodeBuilder.buildNoteFromProps
47
+ ```ts
48
+ {
49
+ root, childrenIds = getRoot
50
+ nodes = [root]
51
+ while nodes {
52
+ toNote it
53
+ }
54
+ }
55
+ ```
56
+
57
+ ## Flow
58
+
59
+ ### Initialize the engine
60
+
61
+ - loc: engine-server/engine.ts
62
+ - desc: initial query to index all notes
63
+
64
+ ```ts
65
+ init {
66
+ @query("**/*", "schema", {
67
+ fullNode: false,
68
+ initialQuery: true,
69
+ });
70
+
71
+ @query("**/*", "note", {
72
+ fullNode: false,
73
+ initialQuery: true,
74
+ });
75
+ }
76
+
77
+ ```
78
+
79
+ ### Query - Engine
80
+
81
+ - loc: engine-server/engine.ts
82
+ - desc: engine will query the store
83
+
84
+ ```ts
85
+ async query(scope: Scope, queryString: string, opts?: QueryOpts) {
86
+ opts = _.defaults(opts || {}, {
87
+ fullNode: false
88
+ });
89
+ if (queryString === '**/*') {
90
+ const data = await this.store.query(scope, '**/*', opts);
91
+ this.refreshNodes(data.data);
92
+ }
93
+ }
94
+ ```
95
+
96
+ ### Query - Store
97
+
98
+ - loc: engine-server/store.ts
99
+ - FileStore.query
100
+ - desc: store is swappable. currently, we only support `FileStore`
101
+
102
+ ```ts
103
+ if (@isQueryAll(queryString)) {
104
+ noteProps = @_getNoteAll() {
105
+ allFiles = getAllFiles({
106
+ root: this.opts.root,
107
+ include: ["*.md"]
108
+ })
109
+ return @files2Notes(allfiles) {
110
+ fp = new FileParser({ errorOnEmpty: false })
111
+ data = fp.parse(allFiles);
112
+ return data.map(n => n.toRawProps());
113
+ }
114
+ }
115
+ const data = new NodeBuilder().buildNoteFromProps(noteProps);
116
+ }
117
+ ```
118
+
119
+ #### Parse Files
120
+
121
+ - loc: engine-server/parser.ts
122
+ - details: read files
123
+
124
+ ```ts
125
+ parse(data: string[]): Note[] {
126
+ fileMetaDict: FileMetaDict = getFileMeta(data) {
127
+ metaDict: FileMetaDict = {};
128
+ _.forEach(fpaths, fpath => {
129
+ { name } = path.parse(fpath);
130
+ lvl = name.split(".").length;
131
+ if (!_.has(metaDict, lvl)) {
132
+ metaDict[lvl] = [];
133
+ }
134
+ metaDict[lvl].push({ prefix: name, fpath });
135
+ });
136
+ return metaDict;
137
+ }
138
+ ...
139
+ root = fileMetaDict[1].find(n => n.fpath === "root.md") as FileMeta;
140
+ const { node: rootNode } = this.toNode(root, [], store, {
141
+ isRoot: true,
142
+ errorOnBadParse: this.opts.errorOnBadParse
143
+ }) as { node: Note };
144
+ ...
145
+ while (_.has(fileMetaDict, lvl)) {
146
+ ...
147
+ const { node, missing } = this.toNode(ent, prevNodes, store, {})
148
+ }
149
+ }
150
+
151
+ toNode {
152
+ noteProps = mdFile2NodeProps(path.join(store.opts.root, ent.fpath)) {
153
+ const { data, content: body } = (matter.read(fpath, {}) as unknown) as {
154
+ const { name: fname } = path.parse(fpath);
155
+ const dataProps = DNodeRaw.createProps({ ...data, fname, body });
156
+ }
157
+ // missing
158
+ if (!parent && !opts.isRoot) {
159
+ missing = parentPath;
160
+ if (opts.errorOnEmpty) {
161
+ throw new Error(JSON.stringify(errorMsg));
162
+ }
163
+ }
164
+ const note = new Note({ ...noteProps, parent, children: [] });
165
+ }
166
+ ```
167
+
168
+ #### Build Nodes
169
+
170
+ - loc: src/node.ts
171
+
172
+ ```ts
173
+ buildNoteFromProps(nodes) {
174
+ // initialize root
175
+ out = []
176
+ root, childrenIds = getRoot nodes {
177
+ if root not in nodes
178
+ throw DendronError // this gets caught in the engine
179
+ return root
180
+ }
181
+ out.push root
182
+ parentNodes = [root]
183
+ nodeIds = childrenIds
184
+
185
+ while nodeIds {
186
+ nodeIds.map {
187
+ nodeProps = nodes.find it.id
188
+ @toNote nodeProps, parentNodes
189
+ }
190
+ }
191
+ }
192
+
193
+ toNote {
194
+ note = new Note(..., children: [], parent: null)
195
+ parent = find(parents)
196
+ parent.addChild note
197
+ ret
198
+ }
199
+ ```
200
+
201
+ # New Node
202
+
203
+ ## Flow
204
+
205
+ - loc: engine-server/engine.ts
206
+
207
+ ```ts
208
+ write(node){
209
+ @store.write
210
+ @updateNodes node
211
+ }
212
+ ```
213
+
214
+ # Updating a Node
215
+
216
+ ## Summary
217
+
218
+ ## Flow
219
+
220
+ - loc: engine-server/engine.ts
221
+
222
+ ```ts
223
+ updateNodes(nodes) {
224
+ if node.type == 'schema' {
225
+ ...
226
+ } else {
227
+ @_updateNote(nodes)
228
+ }
229
+ }
230
+
231
+ _updateNote(nodes, opts) {
232
+ addParent(nodes) if !opts.noAddParent
233
+ @refreshNodes
234
+ }
235
+
236
+ ```
237
+
238
+ # Deleting a Node
239
+
240
+ ## Summary
241
+
242
+ ## Flow
243
+
244
+ - loc: engine-server/engine.ts
245
+
246
+ ```ts
247
+ delete(idOrFname, mode, opts) {
248
+ if (mode == 'note') {
249
+ noteToDelete := @notes
250
+ } else {
251
+ // schemas
252
+ ...
253
+ }
254
+
255
+ // delete from store
256
+ if !opts.metaOnly {
257
+ @store.delete(noteToDelete)
258
+ }
259
+
260
+ // remove from index
261
+ @deleteFromNodes noteToDelete
262
+
263
+ // if node has children , keep it in index as a stub
264
+ if noteToDelete.children {
265
+ noteToDelete.stub = true
266
+ @refreshNotes noteToDelete
267
+ } else {
268
+ // remove node from parent
269
+ noteToDelete.parent.children.reject { noteToDelete } if noteToDelete.parent
270
+ }
271
+
272
+
273
+
274
+ }
275
+ ```
276
+
277
+ # Parsing note references
278
+
279
+ ((ref:[[dendron.topic.refs]]#references,1:#*))
280
+
281
+ ## Summary
282
+
283
+ ## Flow
284
+
285
+ - engine-server/src/topics/markdown/plugins/dendronRefsPlugin.ts
286
+ - data:
287
+ - [[replaceRefs|dendron.scratch.2020.09.12-091632]]
288
+
289
+ ```ts
290
+ dendronRefsPlugin({..., replaceRefs}) {
291
+ // match note ref
292
+ match := /^\(\((?<ref>[^)]+)\)\)/.match(text)
293
+
294
+ stringify(link) := {
295
+ body = read(join(root, link.name + ".md))
296
+ bodyAST = getProcessor.parse(body)
297
+
298
+ refRange = calculateRefRange(body, link)
299
+ bodyAST.children = bodyAST.children.slice(refRange)
300
+ out = getProcessor().stringify(bodyAST);
301
+ ...
302
+ if (renderWithOutline) {
303
+ link = getProcessor()
304
+ .use(replaceRef, {
305
+ wikiLink2Html: true
306
+ })
307
+ .process(link)
308
+ return doRenderWithOutline(link, ...)
309
+ }
310
+ return out
311
+ }
312
+
313
+ }
314
+ ```
315
+
316
+ - engine-server/src/topics/markdown/plugins/replaceRefs.ts
317
+
318
+ ```
319
+ replaceRefs(node) {
320
+ if node.type == 'wikilink' {
321
+
322
+ }
323
+ }
324
+
325
+ ```
326
+
327
+ ## Related
328
+
329
+ - engine-server/src/utils.ts
330
+
331
+ ```ts
332
+ parseDendronRef {
333
+ ...
334
+ }
335
+ ```
336
+
337
+ # Reference
338
+
339
+ ## Refresh Node
340
+
341
+ - loc: engine-server/src/engine.ts
342
+
343
+ ```ts
344
+ refreshNodes(nodes) {
345
+ ...
346
+ type = nodes[0].type
347
+ if type == schema {
348
+
349
+ } else {
350
+ ...
351
+ }
352
+ @updateLocalCollection nodes {
353
+ @schemaFuse.setCollection nodes
354
+ }
355
+ @store.updateNodes nodes
356
+ }
357
+
358
+ ```
359
+

Added: vault/dendron.dev.design.files-vs-folders.md

vault/dendron.dev.design.files-vs-folders.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ id: da241d31-8a05-429c-a041-02ac6170bf20
3
+ title: Dotted filenames
4
+ desc: ''
5
+ updated: 1600270046572
6
+ created: 1600270046572
7
+ stub: false
8
+ ---
9
+ - note renames are simpler, no need to create / delete folders
10
+ - note containers can be created with a single artifact (e.g. foo.bar.md is the container for foo.bar vs. foo/bar.md + foo/bar/)
11
+ - note stubs can be created without intermediate folders
12
+
13
+ # Folder Hierarchies
14
+
15
+ - familiarity - dendron file structure looks like any other part of the file system. Less to learn, faster to adopt
16
+ - you can place any files (e.g. pdfs, xlsx or draw.io diagrams) into the folders without renaming them (and reference them with the same mechanics)
17
+ - easier to save files into the right place of the structure without the assistance of vscode (e.g. normal drag-and-drop works)
18
+ - natural "zoom" functionality into the structure (just open the folder)
19
+ - filenames look cleaner in vscode (in several views, like explorer, file tabs, git etc) as well as in normal OS utilities
20
+ - large amount of files in the same folder makes normal file system tools less useful (OS file explorer, commands like ls or tree, potential choking of operations)
21
+ - less implementation needed for dendron (e.g. no need for dendron tree view since normal file explorer works)
22
+ - other vscode extensions rely on file structures for cleaner views (e.g. TODO tree). Not all views can be re-implemented for dendron
23
+ - normal file system permissions could be used to limit visibility to certain sub-hierarchies
24
+ - various sub-parts of the hierarchy can be brought into the same workspace via symlinks
25
+ - Is compliant with enterprise setting, many companies just wouldn't adopt dot-based hierarcies for their knowledge-base (it's "too weird", "unproven" etc.)
26
+

Added: vault/dendron.dev.design.lookup.md

Files changed (1) hide show
  1. vault/dendron.dev.design.lookup.md +136 -0
vault/dendron.dev.design.lookup.md ADDED
@@ -0,0 +1,136 @@
1
+ ---
2
+ id: 99f7dd68-b2dc-46d0-a556-8a607223dc25
3
+ title: Lookup
4
+ desc: ''
5
+ updated: 1604600828175
6
+ created: 1602392064100
7
+ stub: false
8
+ ---
9
+ ## Lookup Command
10
+
11
+ - src: plugin-core/src/components/lookup/LookupControllerV2.ts
12
+
13
+ ```ts
14
+ show {
15
+ ...
16
+ provider = new LookupProviderV2
17
+ picker :=
18
+
19
+ @updatePickerBehavior(provider, picker)
20
+ quickPick.onDidTriggerButton = ...
21
+ ...
22
+ provider.provide(quickPick)
23
+ ...
24
+ quickPick.show
25
+ }
26
+ ```
27
+
28
+ ### updatePickerBehavior
29
+
30
+ ```ts
31
+ updatePickerBehavior(quickpick, provider) {
32
+ buttons :=
33
+ selectedPath := buttons
34
+ selectedSelection := buttons
35
+
36
+ switch selectedPath {
37
+ case journal {
38
+ quickpick.value :=
39
+ provider.onUpdatePickerItem(
40
+ ....
41
+ )
42
+ }
43
+ }
44
+
45
+ switch selectedSelection {
46
+ case {
47
+ ...
48
+ }
49
+ }
50
+
51
+ }
52
+ ```
53
+
54
+ ### provide
55
+
56
+ - file: src/components/lookup/LookupProviderV2.ts
57
+
58
+ ```ts
59
+ provider picker {
60
+ picker.onDidAccept = @onDidAccept
61
+ picker.onDidChangeValue = @onUpdatePickerItem
62
+ }
63
+
64
+ ```
65
+
66
+ ## Lookup Modifiers
67
+
68
+ ```ts
69
+ cons(opts) {
70
+ lookupSelectionType := CONFIG.DEFAULT_LOOKUP_CREATE_BEHAVIOR
71
+ noteSelectionType := opts
72
+ effectTypes := opts
73
+
74
+ types = [lookupSelectionType, noteSelectioType, effectTypes]
75
+
76
+ this.state {
77
+ buttons: createAllButtons(types)
78
+ }
79
+ }
80
+
81
+ show {
82
+ picker := createPicker
83
+ ...
84
+ @updatePickerBehavior(picker)
85
+ @refreshButtons(picker, @state.buttons)
86
+ picker.onTriggerButton = @onTriggerButton
87
+
88
+ }
89
+
90
+ onTriggerButton(btn) {
91
+ btnTriggered := find(state.buttons, btn)
92
+ btnTriggered.pressed = !btnTriggered.pressed
93
+ btnCategory := btn
94
+ ...
95
+ @refreshButtons(picker, @state.buttons)
96
+ @updatePickerBehavior
97
+ }
98
+
99
+ updatePickerBehavior {
100
+ ...
101
+ @updateBehaviorByEffect
102
+ @updateBehaviorByNoteType
103
+
104
+ }
105
+ updateBehaviorByEffect {
106
+ effectButtons.map(btn.handle)
107
+ }
108
+
109
+ updateBehaviorByNoteType {
110
+ ...
111
+ provider.onUpdatePickerItem(quickPick, provider.opts, onUpdateReason);
112
+ }
113
+ ```
114
+
115
+ ```ts
116
+ onUpdatePickerItem(picker) {
117
+
118
+ showRootResults if (qs == "")
119
+
120
+ updatedItems = picker.items
121
+
122
+
123
+ if (qs.endsWith(.) || query.levels < 2 || picker.justActivated) {
124
+ resp = engine.query
125
+ updatedItems = [noActiveItem] + resp
126
+ }
127
+
128
+ ...
129
+
130
+ addSchemaSuggestions(qs)
131
+
132
+
133
+ }
134
+
135
+ ```
136
+

Added: vault/dendron.dev.design.md

Files changed (1) hide show
  1. vault/dendron.dev.design.md +85 -0
vault/dendron.dev.design.md ADDED
@@ -0,0 +1,85 @@
1
+ ---
2
+ id: c160ddce-edec-4f6e-841b-418d6030fa37
3
+ title: Design
4
+ desc: ''
5
+ updated: 1613007487633
6
+ created: 1598651922993
7
+ stub: false
8
+ ---
9
+ ## Overview
10
+
11
+ Dendron is composed of three main components and a collection of complementing libraries.
12
+
13
+ Below is a sketch of the General Architecture
14
+ ```
15
+ |Dendron Plugin| (vscode) <-> |API Server <-> Dendron Engine| (local express server)
16
+ ```
17
+ ## Major Components
18
+
19
+ ### Dendron Plugin
20
+ - name: @dendronhq/plugin-core
21
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/plugin-core)
22
+
23
+ This is the Dendron VSCode extension
24
+
25
+ ### Dendron Engine
26
+ - name: @dendronhq/engine-server
27
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/engine-server)
28
+
29
+ This is responsible for Dendron's hierarchal index and lookup capabilities. It also contains Dendron specific markdown parsers. While the name says `server`, there is no server that comes with the engine
30
+
31
+ ### Dendron API Server
32
+ - name: @dendronhq/api-server
33
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/api-server)
34
+
35
+ This package contains the express server implementation for Dendron. It provides a REST based shim to allow the Dendron plugin to talk to the engine.
36
+
37
+
38
+ ## Other Components
39
+ ### Dendron Common All
40
+
41
+ - name: @dendronhq/common-all
42
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/common-all)
43
+
44
+ This is a bunch of types and utilities that is consumed by multiple Dendron dependencies
45
+
46
+ ### Dendron Common Server
47
+
48
+ - name: @dendronhq/common-server
49
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/common-server)
50
+
51
+ This is common utilities that are used by server-side versions of Dendron (currently, this is the only available built of Dendron - in the future, the plan is to have a browser only client)
52
+
53
+ ### Dendron CLI
54
+
55
+ - name: @dendronhq/dendron-cli
56
+ - [repo](https://github.com/dendronhq/dendron/tree/master/packages/dendron-cli)
57
+
58
+ This package lets you access Dendron via CLI.
59
+
60
+ <!-- ### Dendron Server
61
+
62
+ This packages contains the vscode LSP server implementation for Dendron. The LSP server will start the `Dendron Express Server` in order to query the engine. -->
63
+
64
+
65
+
66
+ <!-- ### LSP Related functionality
67
+
68
+ ```
69
+ Dendron Plugin <-> LSP Server <-> Express Server <-> Dendron Engine
70
+ ``` -->
71
+
72
+ <!-- ### Non-LSP Functionality -->
73
+
74
+ <!-- - if no server is set
75
+
76
+ ```
77
+ Dendron CLI <-> Dendron Engine
78
+ ```
79
+
80
+ - if server is set (able to use engine instead of re-indexing)
81
+
82
+ ```
83
+ Dendron CLI <-> Express Server <-> Dendron Engine
84
+ ```
85
+ -->

Added: vault/dendron.dev.design.pods.md

Files changed (1) hide show
  1. vault/dendron.dev.design.pods.md +55 -0
vault/dendron.dev.design.pods.md ADDED
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: 92a4f470-1803-4dce-8872-1a7009d8500b
3
+ title: Pods
4
+ desc: ''
5
+ updated: 1608485512282
6
+ created: 1602714464908
7
+ stub: false
8
+ ---
9
+ ## Export Pod
10
+
11
+ - execute
12
+
13
+ ```bash
14
+ dendron-cli export-pod
15
+ ```
16
+
17
+ - src/commands/pod.ts
18
+
19
+ ```ts
20
+ enrichArgs {
21
+ podClass :=
22
+ config = getPodConfig :=
23
+ if !config {
24
+ throw "no-config"
25
+ }
26
+ }
27
+
28
+ execute {
29
+ podClass, config :=
30
+ new podClass().plant(config)
31
+ }
32
+ ```
33
+
34
+ - src/builtin/JSONPod.ts
35
+
36
+ ```ts
37
+ plant {
38
+ cleanConfig :=
39
+ payload = prepareForExport()
40
+ destPath :=
41
+ write(destPath, payload)
42
+ }
43
+ ```
44
+
45
+ - src/base.ts
46
+
47
+ ```ts
48
+ prepareForExport {
49
+ @initEngine
50
+ nodes :=
51
+ ...
52
+ return nodes
53
+ }
54
+ ```
55
+

Added: vault/dendron.dev.design.publishing.md

vault/dendron.dev.design.publishing.md ADDED
@@ -0,0 +1,45 @@
1
+ ---
2
+ id: 8ec553b8-5dfc-4a72-b73f-25c8e59d1538
3
+ title: Publishing
4
+ desc: ''
5
+ updated: 1599927898931
6
+ created: 1599927898931
7
+ stub: false
8
+ ---
9
+ ## Summary
10
+
11
+ ## Flows
12
+
13
+ - src/commands/build-site.ts
14
+
15
+ ```ts
16
+ siteHierarchies := read(dendron.yml)
17
+
18
+ nav_order = 0
19
+ nodes = siteHierarchies { hRoot
20
+ note := engine.notes[hRoot]
21
+ note.nav_order = nav_order
22
+ note.parent = null
23
+ ...
24
+ }
25
+ ...
26
+ while nodes {
27
+ node = nodes.pop
28
+ note2JekyllMdFile(node, {
29
+ notesDir: siteNotesDirPath
30
+ })
31
+ }
32
+
33
+ ```
34
+
35
+ - src/commands/build-site.ts
36
+
37
+ ```ts
38
+ note2JekyllMdFile {
39
+ ...
40
+ note.body = getProcessor()
41
+ ...
42
+ .process(note.body)
43
+ }
44
+ ```
45
+

Added: vault/dendron.dev.design.remark.md

Files changed (1) hide show
  1. vault/dendron.dev.design.remark.md +88 -0
vault/dendron.dev.design.remark.md ADDED
@@ -0,0 +1,88 @@
1
+ ---
2
+ id: d8a09d7b-8693-437c-8a2c-2bfe0b3c2768
3
+ title: Remark
4
+ desc: ''
5
+ updated: 1604676771824
6
+ created: 1602033034187
7
+ stub: false
8
+ ---
9
+ ## Summary
10
+
11
+ This goes over how Dendron parses markdown files
12
+
13
+ ## Init
14
+
15
+ ### Get Processor
16
+
17
+ This starts markdown parsing. It's called in multiple points (eg. dendron-cli, dendron markdown preview enhanced, etc) when markdown needs to be converted.
18
+
19
+ - file: engine-server/src/topics/markdown/utils.ts
20
+
21
+ ```ts
22
+ getProcessor()
23
+ .use(markdownParse, { gfm: true })
24
+ .use(frontmatterPlugin, ["yaml"])
25
+ .use(dendronLinksPlugin)
26
+ .use(dendronRefsPlugin, { root, renderWithOutline, replaceRefs })
27
+ .use({ settings: { listItemIndent: "1", fences: true } });
28
+ ```
29
+
30
+ ## Note References
31
+
32
+ References are parsed using the `dendronRefsPlugin`.
33
+
34
+ - file: engine-server/src/topics/markdown/plugins/dendronRefsPlugin.ts
35
+
36
+ ### Parse
37
+
38
+ ```ts
39
+ plugin.inlineTokenizer(eat, value) {
40
+ if match(eat, DENDRON_REF):
41
+ link := match
42
+
43
+ return {
44
+ type: refLink,
45
+ value: normalize(link)
46
+ }
47
+ }
48
+ ```
49
+
50
+ ### Stringify
51
+
52
+ ```ts
53
+ plugin.Compiler {
54
+ visitor.refLink(content) {
55
+ link :=
56
+ bodyOfTarget = read(link)
57
+ markers = findRef(link, bodyOfTarget)
58
+ return modifyContent(content, markers)
59
+ }
60
+ }
61
+
62
+ ```
63
+
64
+ ## Replace Links
65
+
66
+ ```ts
67
+ getRemark(opts) {
68
+ dendronLinksOpts := opts
69
+ remark()
70
+ ...
71
+ .use(dendronLinksPlugin, dendronLinksOpts)
72
+ }
73
+ ```
74
+
75
+ - src/topics/markdown/plugins/dendronLinksPlugin.ts
76
+
77
+ ```ts
78
+
79
+ plugin.Compiler({replaceLink}) {
80
+ if replaceLink {
81
+ node.value = replaceLink.to.fname;
82
+ if node.data.alias != replaceLink.from.fname {
83
+ node.data.alias = opts.replace.to.fname
84
+ }
85
+ }
86
+ }
87
+ ```
88
+

Added: vault/dendron.dev.design.seeds.md

Files changed (1) hide show
  1. vault/dendron.dev.design.seeds.md +30 -0
vault/dendron.dev.design.seeds.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: 6a801f8a-af4a-4665-9ee5-144877e7cad7
3
+ title: PlantSeed
4
+ desc: ''
5
+ updated: 1602890605707
6
+ created: 1602890605707
7
+ stub: false
8
+ ---
9
+ - file: src/commands/plantSeed.ts
10
+
11
+ ```ts
12
+ execute( id ){
13
+ SeedClass := id
14
+ new SeedClass().plan()
15
+ }
16
+ ```
17
+
18
+ - src/base.ts
19
+
20
+ ```ts
21
+ plant {
22
+ config = this.config()
23
+ metadata = @fetch(config)
24
+ @engine.init()
25
+ notes, assets = @prepare
26
+ @writeAssets assets
27
+ @writeNotes nots
28
+ }
29
+ ```
30
+

Added: vault/dendron.dev.issues.md

Files changed (1) hide show
  1. vault/dendron.dev.issues.md +15 -0
vault/dendron.dev.issues.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: af2ba46a-4dbc-4648-9d4c-f6d6d2e3bb50
3
+ title: Issues
4
+ desc: ''
5
+ updated: 1608593535254
6
+ created: 1608593449583
7
+ ---
8
+ ### gyp issue when installing
9
+
10
+ - Call to 'krb5-config gssapi --libs' returned exit status 127 while in binding.gyp. while trying to load binding.gyp
11
+
12
+ ```bash
13
+ yum install make glibc-devel gcc patch
14
+ ```
15
+

Added: vault/dendron.dev.md

Files changed (1) hide show
  1. vault/dendron.dev.md +15 -0
vault/dendron.dev.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: 3489b652-cd0e-4ac8-a734-08094dc043eb
3
+ title: Development
4
+ desc: ''
5
+ updated: 1604511673556
6
+ created: 1598645869692
7
+ stub: false
8
+ nav_order: 9.6
9
+ ---
10
+ If you would like to contribute to the development of dendron, you can do so by checkout out the [repo](https://github.com/dendronhq/dendron) from github.
11
+
12
+ You can then follow the setup instructions below to prepare your first commit!
13
+
14
+ ((ref:[[dendron.dev.setup]]#getting started))
15
+

Added: vault/dendron.dev.ref.kevins-setup.md

vault/dendron.dev.ref.kevins-setup.md ADDED
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: 10e86d42-e3e3-4aae-92ad-c086b776f34e
3
+ title: Kevins Setup
4
+ desc: ''
5
+ updated: 1612801485282
6
+ created: 1612801401299
7
+ ---
8
+
9
+
10
+ Dendron has a lot of moving parts so I try to divide my workspace accordingly.
11
+
12
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dev.kevin.jpg)
13
+
14
+ - 1: What I'm working on
15
+ - 2 and 3: Related project (eg. if 1 was the plugin, 2 & 3 might be `engine-server` and `api-server` respectively)
16
+ - 4 and 5: This is where I keep common utils/libs (eg. `common-all`, type definitions, etc)
17
+
18
+ Since your screen space can be pretty small when doing this, I use the following keyboard shortcut to trigger maximizing panes
19
+
20
+ ```json
21
+ {
22
+ "command": "workbench.action.toggleEditorWidths",
23
+ "key": "ctrl+cmd+m"
24
+ }
25
+ ```
26
+
27
+ I also try to document the main logic when I run into it in the {project}.internals hierarchy on our site: https://dendron.so/notes/4b8f0470-dacb-433b-8d0c-f5a7d8f5245d.html

Added: vault/dendron.dev.ref.lifecylce.md

Files changed (1) hide show
  1. vault/dendron.dev.ref.lifecylce.md +18 -0
vault/dendron.dev.ref.lifecylce.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: 5e164216-c464-4a6f-ae85-a6f5cbc787e7
3
+ title: Extension
4
+ desc: ''
5
+ updated: 1608754259470
6
+ created: 1604341985772
7
+ ---
8
+ - not_initialized
9
+ - tried starting workspace but something went wrong
10
+ - initialized
11
+ - reloadWorkspace complete
12
+ - **upgraded**
13
+ - upgrade workspace complete
14
+ - upgraded (optional)
15
+ - extension has upgraded
16
+ - activate
17
+ - finish showWelcome
18
+

Added: vault/dendron.dev.ref.md

Files changed (1) hide show
  1. vault/dendron.dev.ref.md +13 -0
vault/dendron.dev.ref.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ id: b5736273-85ad-4d0c-bb30-89c92a3941da
3
+ title: Ref
4
+ desc: ''
5
+ updated: 1604418668529
6
+ created: 1604418668529
7
+ stub: false
8
+ parent: 3489b652-cd0e-4ac8-a734-08094dc043eb
9
+ children:
10
+ - 5e164216-c464-4a6f-ae85-a6f5cbc787e7
11
+ ---
12
+
13
+

Added: vault/dendron.dev.ref.vscode.md

Files changed (1) hide show
  1. vault/dendron.dev.ref.vscode.md +17 -0
vault/dendron.dev.ref.vscode.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ id: 3307c16e-69d9-48cd-b1cc-1dfe88274191
3
+ title: Vscode
4
+ desc: ''
5
+ updated: 1614837534125
6
+ created: 1608754262068
7
+ ---
8
+
9
+ ## Tasks
10
+ - [vscode docs](https://code.visualstudio.com/docs/editor/tasks)
11
+
12
+ - workspace specific way of executing scripts
13
+
14
+
15
+ ## Debug Pane
16
+
17
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dev.vscode-debug.jpg)

Added: vault/dendron.dev.setup.md

Files changed (1) hide show
  1. vault/dendron.dev.setup.md +87 -0
vault/dendron.dev.setup.md ADDED
@@ -0,0 +1,87 @@
1
+ ---
2
+ id: 64f0e2d5-2c83-43df-9144-40f2c68935aa
3
+ title: Setup
4
+ desc: ''
5
+ updated: 1614313342658
6
+ created: 1598651458825
7
+ stub: false
8
+ ---
9
+ ## Getting Started
10
+
11
+ ### 1. Requirements
12
+
13
+ Before you begin, you need to make sure to have the following SDKs and tools:
14
+
15
+ - [Node.js >= 12.0.0](https://nodejs.org/download/release/latest-v10.x/)
16
+ - We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
17
+
18
+ ### 2. Clone and npm install
19
+
20
+ ```bash
21
+ git clone https://github.com/dendronhq/dendron.git
22
+ cd dendron
23
+ npm install
24
+ ```
25
+
26
+ ### 3. Build Repo
27
+
28
+ - you should run this when building dendron for the first time and also every time you run a git pull
29
+ - new dependencies might have been picked up between pulls and this makes sure that they are installed
30
+
31
+ ```bash
32
+ yarn bootstrap:bootstrap
33
+ yarn bootstrap:build
34
+ ```
35
+
36
+ - we recommend you use `vscode` to develop for dendron. there is a `dendron.code-workspace` file in the root of the monorepo that you should use when developing
37
+
38
+ ### 4. Editing (the plugin)
39
+
40
+ At the root of the monorepo, open `dendron-main.code-workspace`. Open this with VSCode to start editing. While its not required to use VSCode, most of the helper scripts in this repository are created with VSCode in mind so using it will make development significantly easier.
41
+
42
+ ### 5. Start Debugging (the plugin)
43
+
44
+ - NOTE: you don't need to do this if you are not directly working on the extension (eg. you're working on the [[server|dendron.pro.dendron-next-server]])
45
+
46
+ To start an instance of the Dendron with the Debugger, Run `Extension (plugin-core)` from the debug panel in vscode
47
+
48
+ ![debugger](/assets/images/start_debugger.gif)
49
+
50
+ _Note: Running via Run -> Start Debugging will not work unless you've previously targeted `Extension (plugin-core)`_
51
+
52
+ ## Tips
53
+
54
+ ### Watch Monorepo
55
+ To continuously compile all dependencies, run the following
56
+
57
+ ```bash
58
+ ./bootstrap/scripts/watch.sh
59
+ ```
60
+
61
+ ## Troubleshooting
62
+
63
+ ### Something went wrong during the build
64
+
65
+ In case something something goes wrong with a build step or you want to save time by not running everything, `init.sh` is just a thin wrapper around the following scripts, each of which can be run individually
66
+
67
+ - ./bootstrap/scripts/bootstrap.sh: `lerna bootstrap all packages`
68
+ - ./bootstrap/scripts/build.sh: `lerna build all packages`
69
+
70
+ ### Changes not showing up in Dendron
71
+
72
+ 1. Are you using the `Run extension` command on the debugger panel to test dendron?
73
+
74
+ 2. If you have one vscode instance which you have dendron installed and are also doing dendron development on, you might get a version conflict. in that case, use `Run extension with plugin disabled` in the debugger panel (or use a different version of vscode to run dendron vs develop)
75
+
76
+ ## Testing
77
+
78
+ - see [[Testing|dendron.dev.testing]]
79
+
80
+ ## Debugging
81
+
82
+ - see [[Debugging|dendron.dev.debug]]
83
+
84
+ ## Style
85
+
86
+ - see [[Style|dendron.dev.style]]
87
+

Added: vault/dendron.dev.style.md

Files changed (1) hide show
  1. vault/dendron.dev.style.md +12 -0
vault/dendron.dev.style.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: 773e0b5a-510f-4c21-acf4-2d1ab3ed741e
3
+ title: Style
4
+ desc: ''
5
+ updated: 1609550434732
6
+ created: 1609550314371
7
+ ---
8
+ Code style guidelines. We use [prettier](https://prettier.io/) to autoformat the code on every commit which helps with most conventional styling conventions. This page lists some additional conventions not covered by prettier.
9
+
10
+ - when importing modules, unless your working with an all javascript package, we want to use `import` syntax over `require` syntax
11
+ - unless there's an obvious performance penalty, we prefer using `async/await` and `Promises` over callbacks
12
+

Added: vault/dendron.dev.testing.md

Files changed (1) hide show
  1. vault/dendron.dev.testing.md +90 -0
vault/dendron.dev.testing.md ADDED
@@ -0,0 +1,90 @@
1
+ ---
2
+ id: cb22bd36-d45a-4ffd-a31e-96c4b39cb7fb
3
+ title: Testing
4
+ desc: ''
5
+ updated: 1610816383624
6
+ created: 1598654055046
7
+ stub: false
8
+ ---
9
+
10
+ ## Overview
11
+
12
+ See remote pairing session for an overview of setting up tests.
13
+
14
+ <iframe width="560" height="315" src="https://www.youtube.com/embed/ueMhGDwMP9M" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
15
+
16
+ - [[Session notes|dendron.dev.testing.notes]]
17
+
18
+ ## Running All Tests
19
+
20
+ ### All packages except the plugin
21
+
22
+ - Inside VSCode
23
+ > Run Task: Test (bootstrap)
24
+
25
+ - Using CLI
26
+
27
+ ```bash
28
+ ./bootstrap/scripts/testAll.sh
29
+ ```
30
+
31
+ ### Run all test for Dendron Plugin (plugin-core)
32
+
33
+ 1. Open the debug view
34
+ 2. Run `Extension Integ Tests` in the dropdown
35
+
36
+ ## Run Specific Test
37
+
38
+ ### Run a specific test for Dendron Plugin
39
+
40
+ 1. Open a test inside 'src/test/suite-integ/' from `plugin-core`
41
+ 2. Run the build task `Extension Integ Tests - File`
42
+
43
+ ### Run a specific test from non-dendron plugin package
44
+
45
+ 1. Go to file
46
+ 2. Use command prompt and run `> Tasks: Run tasks`
47
+ 3. Find the appropriate package and run `> npm:test:watch {package}`
48
+
49
+ ## Writing Tests
50
+
51
+ All packages have tests written in `jest` except plugin-core. these tests use `mocha` assertion because vscode has a special test harness built around `mocha`
52
+
53
+ ## Debugging Tests
54
+
55
+ You can put a breakpoint directly in any code that's part of `plugin-core` and it'll break at those points
56
+
57
+ > Kevin's Aside: If you need to debug a related package, I haven't found a good way to put a break point. Instead, I manually insert a `debugger` statement and vscode will break. Don't forget to remove the `debugger` statement
58
+
59
+
60
+ ## Anatomy of an Engine Test
61
+
62
+ - pre-req:
63
+ - read over the overall [[design|dendron.dev.design#overview]] for Dendron
64
+
65
+ Testing the engine in Dendron involves a little bit of setup because:
66
+ - it requires initializing the engine and seeding it with the right fixture for the test
67
+ - it might require the same functionality be tested in multiple environments (plugin, CLI, server, engine, etc)
68
+ - it might require using multiple test runners (dendron uses `jest` for all tests except for the [[dendron plugin|dendron.dev.design#dendron-plugin]] which uses [[mocha|dendron.pro.dendron-plugin.qa#test-runner]])
69
+
70
+ Because of the aforementioned issues, we've created the following two classes to make testing easier and re-usable across environments.
71
+
72
+ ### runEngineTest
73
+
74
+ - setup a mock dendron environment
75
+ - initialize the dendron engine
76
+ - optionally seed engine with a preset
77
+
78
+ - NOTE: there are currently multiple versions of this which track multiple generations of engine design
79
+ - the most current version is `runEngineTestV5`
80
+ - see example of usage [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-test-utils/src/__tests__/site.spec.ts#L84:L84)
81
+
82
+
83
+ ### TestPresetEntry
84
+ - [code](https://github.com/dendronhq/dendron/blob/master/packages/common-test-utils/src/utilsv2.ts#L48:L48)
85
+
86
+ - this helps us create a `TestPreset` which is to be used with `runEngineTest`
87
+ - lets you add different lifecycle hooks as the engine is beign initialized
88
+
89
+ - NOTE: there are currently multiple versions of this
90
+ - the most current version is `TestPresetEntryV4`

Added: vault/dendron.dev.testing.notes.md

Files changed (1) hide show
  1. vault/dendron.dev.testing.notes.md +66 -0
vault/dendron.dev.testing.notes.md ADDED
@@ -0,0 +1,66 @@
1
+ ---
2
+ id: bf26c697-3e70-4e34-b15d-ef40c4b7d429
3
+ title: Notes
4
+ desc: ''
5
+ updated: 1610816370506
6
+ created: 1610816231328
7
+ ---
8
+
9
+ Thank you [Mark H. Choi](https://github.com/hikchoi/cerebrarium) for the below notes
10
+
11
+ ## Session goal
12
+ - Add a test for MarkdownPublishPod
13
+ - Show how tests are set up for Dendron
14
+
15
+ ## watch
16
+
17
+ ```bash
18
+ cd bootstrap/scripts
19
+ ./watch.sh
20
+ ```
21
+ - Dendron is made up of a multiple typescript projects
22
+ - This script will watch all of them and compile them when you make change to the code.
23
+
24
+ ---
25
+
26
+ ## Testing in Dendron
27
+
28
+ - All tests are managed with jest.
29
+ - Except the plugin itself, which uses mocha
30
+ - mocha is very well integrated into VSCode's [test harness](https://en.wikipedia.org/wiki/Test_harness)
31
+ - Any test code that are not testing plugin functionality are
32
+ - located in the `__tests__` directory
33
+ - in the file name formatted `TestName.spec.ts`
34
+ - To run a test, use VSCode tasks
35
+ - `cmd` + `shift` + `p`, -> `Task: Run Task` in the command palette
36
+ - Select the appropriate task to run.
37
+ - These are vscode wrappers around bash scripts.
38
+ - In our case, we want to test `MarkdownPod.spec.ts`
39
+ - Type `npm:test:watch` in the task comman palette
40
+ - There will be a number of selections, marked with which project's test it will be running.
41
+ - Select the one marked with `pods-core`, as we are testing pods today.
42
+ - This will open a terminal and run `jest --watch` on the specific test we are interested in.
43
+ - Now jest will run all the tests for you every time you change your test code
44
+ - Writing new tests
45
+ - Start a new [describe block](https://jestjs.io/docs/en/api#describename-fn), and give it an appropriate name.
46
+ - Write a new test case.
47
+ - Use `runEngineTest`
48
+ - Multiple versions of this exists
49
+ - Make sure you import the right version of this.
50
+ - This is a typescript thing (?)
51
+ - There are preset scenarios for testing
52
+ - These are `PreSetupHookFunctions`
53
+ - They set up hard-coded notes in a vault so that they can be used in a test
54
+ - Quick jest tip: use snapshots to grab a test result (something long that you don't really want to construct manually), and use that for your assertions
55
+ - These can be found in `__tests__/__snapshots__`
56
+ - Don't forget to remove the snapshot code for the final test code if it isn't necessary.
57
+ - Clean up any unused code / warnings
58
+ - After writing all the tests, check again by running the entire test suite
59
+ - Run `Test: bootstrap` found under `Task: Run Task`
60
+ - This will all tests in all packages.
61
+ - We want to do this before commiting because Dendron is a mono-repo, and most packages have dependencies on each other.
62
+ - We want to make sure our changes aren't breaking something elsewhere.
63
+ - Github action that will automatically do this for every push will be coming soon.
64
+ - If you want to be more careful, you can also test the plugin itself at this point.
65
+ - The above step tests every single package that is not a plugin.
66
+ - To run tests for the plugin itself, run `Extension Integ Tests (plugin-core)`, which can be found in the Run pane.

Added: vault/dendron.dev.triage.md

Files changed (1) hide show
  1. vault/dendron.dev.triage.md +97 -0
vault/dendron.dev.triage.md ADDED
@@ -0,0 +1,97 @@
1
+ ---
2
+ id: 1e6c8b49-ef88-4e79-b2df-e9d614c38a53
3
+ title: Triage
4
+ desc: ''
5
+ updated: 1613821943272
6
+ created: 1610468038819
7
+ ---
8
+
9
+ This describes how Dendron [issues](https://github.com/dendronhq/dendron/labels?page=1&sort=name-asc) are laid out in github.
10
+
11
+ ## general
12
+
13
+ ### Epic
14
+
15
+ This is a collection of multiple tasks
16
+
17
+ ## area
18
+
19
+ different components of dendron
20
+
21
+ ### hierarchy
22
+
23
+ Everything that has to do with the hierarchy's be it the schema files or other things where they play a role.
24
+
25
+ ### workbench
26
+
27
+ If you have problems with the workbench components that get provided by dendron like the "Dendron Tree View" or the "Backlink" panel.
28
+
29
+ ### pods
30
+
31
+ Everything about pods, requests for new ones or problems with existing ones
32
+
33
+ ### seeds
34
+
35
+ Everything about seeds, requests for new ones or problems with existing ones
36
+
37
+ ### markdown
38
+
39
+ Features or issues with the parsing of markdown and it's related syntax
40
+
41
+ ### engine
42
+
43
+ Dendron backend
44
+
45
+ ### publishing
46
+
47
+ Publishing related features
48
+
49
+ ### ui
50
+
51
+ WebView related functionality
52
+
53
+ #### graph
54
+
55
+ Features or Issues related to the Graph
56
+
57
+ ## size
58
+
59
+ ### small
60
+
61
+ good first task
62
+
63
+ ### medium
64
+
65
+ good task after you have done a few `small` tasks
66
+
67
+ ### large
68
+
69
+ big undertaking, might take a few days and touches multiple components
70
+
71
+ ## status
72
+
73
+ ### help-wanted
74
+
75
+ feature not in scope of current timeline. looking for outside contributors
76
+
77
+ ### pending
78
+
79
+ waiting for response from submiter
80
+
81
+ ### triage-needed
82
+
83
+ everything that has this label still needs to be looked over by a Contributor or member of [Dendronhq](https://github.com/dendronhq)
84
+
85
+ ## type
86
+
87
+ ### bug
88
+
89
+ Everything that does not work as intended lands here
90
+
91
+ ### enhancement
92
+
93
+ Improvements to existing features
94
+
95
+ ### feature
96
+
97
+ Requests for new Features land here

Added: vault/dendron.dev.windows.md

Files changed (1) hide show
  1. vault/dendron.dev.windows.md +44 -0
vault/dendron.dev.windows.md ADDED
@@ -0,0 +1,44 @@
1
+ ---
2
+ id: d0f34b08-0725-4ec5-a600-a4d6309bb2ae
3
+ title: Windows
4
+ desc: 'Windows gotchas'
5
+ updated: 1615168192996
6
+ created: 1615165852271
7
+ ---
8
+
9
+ The Dendron VSCode extension is built in TypeScript and uses a lot of JavaScript tooling to build and compile, and does not always play nice with Windows.
10
+
11
+ Here are some of the things to look out for.
12
+
13
+ ## git
14
+
15
+ Most of the Dendron developers use Mac or Linux, so the file endings and permissions are not the same.
16
+ After you build Dendron, git will pick up a lot of file changes that don't actually exist [^diff].
17
+
18
+ In order to fix this (preferably do this before building Dendron):
19
+
20
+ - Create a .gitattributes file in the root of the Dendron repo and add `* text=auto` [^lineendings]
21
+ - run `git config --add core.filemode false` on the repo [^chmod]
22
+
23
+ If you are still seeing blank changes in git run:
24
+
25
+ - `git add --renormalize .` [^diff] (yes there is a single dot at the end of the command.)
26
+
27
+ ## watch script
28
+
29
+ Dendron has a watch.sh script which will continuously compile all dependencies while you are developing. This is useful, but windows does not run shell scripts natively...
30
+
31
+ The easiest way to run shell scripts on Windows is to use git BASH[^git][^gitbash], which gets automatically installed, when you install git for windows. (It should also already be on your PATH.)
32
+
33
+ Open git BASH inside the Dendron repo and run the script:
34
+
35
+ ```
36
+ ./bootstrap/scripts/watch.sh
37
+ ```
38
+
39
+
40
+ [^diff]: [git status shows changed files but git diff doesn't](https://stackoverflow.com/questions/14564946/git-status-shows-changed-files-but-git-diff-doesnt)
41
+ [^chmod]: [How do I make git ignore file mode (chmod) changed?](https://stackoverflow.com/questions/1580596/how-do-i-make-git-ignore-file-mode-chmod-changes)
42
+ [^lineendings]: [How to change line-ending settings](https://stackoverflow.com/questions/10418975/how-to-change-line-ending-settings)
43
+ [^git]: [git for Windows](https://gitforwindows.org/)
44
+ [^gitbash]: [How to run shell scripts on Window](https://www.thewindowsclub.com/how-to-run-sh-or-shell-script-file-in-windows-10) See last comment

Added: vault/dendron.faq.md

Files changed (1) hide show
  1. vault/dendron.faq.md +238 -0
vault/dendron.faq.md ADDED
@@ -0,0 +1,238 @@
1
+ ---
2
+ id: 683740e3-70ce-4a47-a1f4-1f140e80b558
3
+ title: FAQ
4
+ desc: ''
5
+ updated: 1612368130856
6
+ created: 1595952505025
7
+ stub: false
8
+ nav_order: 6
9
+ ---
10
+ All the questions we thought you might ask.
11
+
12
+ ## General
13
+
14
+ ### What is a Dendron?
15
+
16
+ A Dendron is many things.
17
+
18
+ 1. Dendron is the greek word for tree. It's a reference to the hierarchal note taking that Dendron(3) enables.
19
+ 2. Dendron is another word for [dendrite](https://en.wikipedia.org/wiki/Dendrite) which is an extension of the nerve cell that sends and receives signals in the brain. Think of Dendron(3) as a digital nervous system that helps you consolidate all the information that you care about in the fastest and most efficient way possible.
20
+ ![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/Neuron_Hand-tuned.svg/2880px-Neuron_Hand-tuned.svg.png)
21
+ - Image by Quasar Jarosz at English Wikipedia
22
+ 3. Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you organize, manage, publish, and collaborate on knowledge bases of any size.
23
+
24
+ ### How is Dendron different from X note taking tool?
25
+
26
+ Substitute X with `roam|obsidian|foam|one note|evernote|...`
27
+
28
+ All note taking tools (try to make it) easy to get notes in. Its getting it back out again that's hard and it **becomes harder** as you get more notes.
29
+
30
+ Whether you are using notebooks tags, or backlinks, once you have more than a few hundred notes, you'll need to have some sort of structure in place (eg. naming convention, hierarchy, etc) to keep track of it.
31
+
32
+ Dendron is a highly opinionated note taking tool that focuses on **hierarchal note taking**. It provides the freedom of Roam's _every note exists everywhere philosophy_ while layering on top **flexible hierarchies** to keep track of it all.
33
+
34
+ While Dendron works with knowledge bases of any size, it really shines once you've accumulated a few hundred notes. I created it to handle my personal knowledge base of 20k+ markdown notes - Dendron lets me track and find any specific note in it in seconds. You can read more about Dendron's hierarchal approach to note taking [here](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html).
35
+
36
+ ### How is Dendron different from Roam?
37
+
38
+ Whereas Roam is built around the idea of **bi-directional links** (and daily journals) which help you create notes without having to explicitly organize your notes, Dendron is built to help you organize notes without friction using **flexible hierarchies**.
39
+
40
+ We provide the tooling to create, enforce, and change these hierarchies at will. If you think of Roam as a graph database for notes, you can think of Dendron as Redis. To give you a sense of scale, I use Dendron to manage a corpus of +20K notes.
41
+
42
+ Some additional features that set Dendron apart:
43
+ - Dendron allows you to compose your workspace with vaults (a vault is a collection of notes that can come from anywhere) from any number of sources
44
+ - Dendron is based on plain text (Dendron flavored) markdown (exportable to regular markdown or any other format)
45
+ - Dendron is integrated into VSCode
46
+ - Dendron allows for easy publishing public/private content to any platform that can host a static site (and we're rolling out our own publishing platform to help people publish with additional access controls)
47
+
48
+ ### How does Dendron help me track my notes?
49
+
50
+ 1. Dendron organizes and collapse all your notes into managable chunks using [[hierarchies|dendron.topic.hierarchies]].
51
+ 2. Dendron helps you manage your hiearchies using [[schemas|dendron.topic.schema]]
52
+ 3. Dendron gets out of your way when your working with your notes during [[lookup|dendron.topic.lookup]]
53
+
54
+ Dendron's secret sauce is that it provides the necessary tooling for you to work with hierarichal notes. While hierarchies have traditionally (and justifiably) gotten a bad, I would argue that this is because the **tooling** around hierarchies were bad, not because hierarchies themselves are bad.
55
+
56
+ Hierarchies are one of the most effective ways that **both humans and computers** process large amount of information (there's a reason why almost every database is built from a variation of the [b-tree](https://en.wikipedia.org/wiki/B-tree)). You can find further details about hierarchies in this [blog post](https://www.kevinslin.com/notes/e1455752-b052-4212-ac6e-cc054659f2bb.html)
57
+
58
+ ### Is Dendron Free? Will it stay free?
59
+
60
+ Dendron, the client, is free and will always remain free. It is also open source so anyone is free to make their own fork of Dendron.
61
+
62
+ That being said, I'm all in on Dendron and this is my full time gig. I want to make sure that developing Dendron remains sustainable. To that end, I plan on introducing value add server side functionality that folks may pay for. Examples of paid for features include:
63
+
64
+ - private hosting (for folks who want to publish but not use github pages or want to add authentication)
65
+ - enterprisy things
66
+ - eg. on premise installations of Dendron with single sign on, active directory, and fine grained permissions
67
+ - offering private subscription based vaults (eg. think [substack](https://substack.com) but having people subscribe to vaults instead of newsletters )
68
+ - server side IFTTT like functionality (eg. everytime I add an entry to airtable, add a note to Dendron)
69
+
70
+ Paid for features will be 100% optional and will not be necessary for any client side functionality in Dendron.
71
+
72
+ ### Why is Dendron built on top of VSCode?
73
+
74
+ As with all things, its a matter of tradeoffs. Dendron started its life as a standalone app (eg. think Obsidian) but I quickly realized I was spending most of my time building undifferentiated editor scaffolding instead of focusing on the hierarchies and schemas that made Dendron unique.
75
+
76
+ I wanted to spend more time building out features that supported Dendron's [hiearchy first approach](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html) to note taking which is what led me to re-write it for VSCode.
77
+
78
+ That being said, the core dendron engine is not vscode specific and there are folks that are experimenting with porting it over to other editors (eg. sublime, vim). We also have plans for a standalone editor in the future (most likely, this will be a fork of VSCode optimized for note taking)
79
+
80
+ ## Working with Notes
81
+
82
+ ### Why markdown?
83
+
84
+ Markdown lets you write text in a simple human readable notation that is platform independent. You don't need to have microsoft word to read a markdown file and now a days, all new note taking tools support importing and displaying markdown.
85
+
86
+ For more context, you can see the original markdown declaration [here](https://daringfireball.net/projects/markdown/)
87
+
88
+ ### Can I use Dendron with existing notes?
89
+
90
+ You can use Dendron with existing repositories of markdown notes.
91
+
92
+ Open the `Command Bar` in vscode and use the `Dendron: Change Workspace` command. It will ask you for a folder path as input.
93
+
94
+ Dendron will create a `dendron.code-workspace` file in specified directory and then open the workspace (if a workspace file already exists, it will use that). It will also create a `root.md` file in that directory if it doesn't exist (currently this is part of the internal working of dendron).
95
+
96
+ Dendron **does not** delete or overwrite any files during the **Change Workspace** operation.
97
+
98
+ ### How do I save?
99
+
100
+ Dendron automatically saves when you change focus (switch tabs or applications). You can also manually save using `Cmd+S` or `Ctrl+S` depending on your operating system
101
+
102
+ ### How do I go back to the previous note?
103
+
104
+ There are 3 ways to go back to my previous note:
105
+
106
+ 1. `ctrl-tab` (go to previous tab)
107
+ 2. click on the previous tab
108
+ 3. using the open editors pane
109
+
110
+ - NOTE: to have more than a single tab show, you need to have the following settings
111
+
112
+ ```json
113
+ {
114
+ "workbench.editor.enablePreview": false,
115
+ "workbench.editor.showTabs": true
116
+ }
117
+ ```
118
+
119
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/faq.go-back.gif)
120
+
121
+ ## Working with Hierarchies
122
+
123
+ ### How should I name a note?
124
+
125
+ There are no rigid requirements on note naming in Dendron, other than the dots in the file name are used to construct the note [[note hierarchy|dendron.topic.hierarchies]]. However, the recommended way is to use all lowercase letters, replace spaces with `-`-mark and remove any special characters. Thus e.g. `John's amazing garage` becomes `johns-amazing-garage`.
126
+
127
+ Also, remember that you will use the note [[lookup-feature|dendron.topic.lookup]] to find notes quickly, and the lookup will use the names of the files. Thus try to name the files using the words that you are likely to use to find the note.
128
+
129
+ ### What kind of note hierarchy should I create?
130
+
131
+ A good guideline is to start with a relatively flat hierarchy (even just a single note in the root!) and add topics as headings into those notes. When notes grow to the point that you have to start scrolling, it’s time to consider if it would be beneficial to split those notes. At that point, you probably already have some idea how the thoughts are placed in your mind - try to mimic that also with the hierarchy.
132
+
133
+ If you have a hard time deciding which ideas belong closer to root, think which of those ideas are more fundamental in your thinking. As an example, a note related to coding in Excel, should it be named as `code.excel` or `excel.code`? This could be resolved by thinking if you will write more about coding where Excel is just one example, or more about Excel, where coding is only one example. In case you think that both `excel.code` and `code.excel` are equal and both should be created, you could also make one of them a “master note” and [[refer|dendron.topic.refs]] to it from the other note.
134
+
135
+ ### Do I have to use hierarchies? What if I want to use another approach?
136
+
137
+ Despite our emphasis on hierarchies, Dendron also supports non-hierarchal ways of organizing notes (eg. backlinks, zettelkasten, etc).
138
+
139
+ You can, and are encouraged to, combine these other workflows with Dendron hierarchies in order to create your own workflow that takes the best parts of each system!
140
+
141
+ ### What if I have a note that belongs in multiple hierarchies?
142
+
143
+ This comes up a lot especially when your dealing with organizing collections of things, like music or books. There are a few approaches we recommend here.
144
+
145
+ 1. Use [[tags|dendron.topic.tags]]. Tags work best with categorical data. If you use **Dendron Tags** (aka they're really hierarchies), then you have the added advantage of being able to refactor and track your tags using Dendron's existing hierarchal tooling.
146
+ 2. Use alias nodes. This is an [upcoming feature](https://github.com/dendronhq/dendron/issues/128) that will allow you to put a node under multiple hierarchies.
147
+
148
+ ### Hierarchies add too much friction
149
+
150
+ The hierarchy adds friction but the idea is that the friction (eg. hierarchy) is not a bug but the reason why dendron works with thousands of notes.
151
+
152
+ The analogy to think about is excel: while putting your numbers inside the structure of a spreadsheet might not be the most straightforward way of getting to a numerical solution, its use becomes indispensable once you deal with a significant amount ofnumbers.
153
+
154
+ The way to think about dendron is that its not like google where you type a question and try to find an answer - until we get true AI, this simply doesn't work for personal knowledge. Rather, Dendron helps you organize your notes so you can reference the information you need to answer your own questions.
155
+
156
+ ## Working with Schemas
157
+
158
+ ### What is the deal with schemas? Do I need to use them?
159
+
160
+ The short answer is no, you don't **need** to use schemas. That being said, schemas can help you manage your notes, especially as you collect more of them.
161
+
162
+ If you're familiar with typescript - Dendron schemas are similar to the types offered by typescript. You can compile your typescript code into javascript even if the types don't match (subject to your tsconfig). Types help make your projects maintainable, especially as they grow.
163
+
164
+ Currently, Dendron will do is show you an indicator if your schema doesn't match. In the future, we'll have a strict mode where we will actually prevent you from creating notes that don't match your schema.
165
+
166
+ Schemas at the end of the day help you construct consistent hierarchies for your notes. Consistent hierarchies alleviate the cognitive overhead of needing to understand and track N things where N can be very big. Instead, you can construct a single schema that encompasses the common areas of all N things.
167
+
168
+ But even if you don't have a lot of notes, schemas are helpful because they provide extra features [like templating](https://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#schema-templates) and [auto complete](https://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#why-use-schemas).
169
+
170
+ <!--
171
+ This allows you to quickly reference anything within your hierarchy because they all have the same shape. It also helps with understanding a topic - I (Kevin, Dendron author) find my schema for a domain tends to reflect my mental model for said domain as well.
172
+
173
+ For example, I'm using nodejs and need to access a file. I have no idea what the builtin/recommended library for file access is. Instead of having to dig up [fs-extra](https://www.npmjs.com/package/fs-extra), I can navigate to `l.node.file` and see my notes on the best way to work with files. You can replace node with any other programming language. Now I have a general way of referencing file access for all languages without needing to remember the specific implementation detail of any of them.
174
+ -->
175
+
176
+ ## Finding Notes
177
+
178
+ ### Can I do filter by the metadata in Dendron?
179
+
180
+ Metadata is currently under utilized because we don't have a built in way of easily querying by it. We currently have [this issue](https://github.com/dendronhq/dendron/issues/152) tracking the progress of advanced query work.
181
+
182
+ In the future, we want to support:
183
+
184
+ - querying by custom frontmatter attributes: <https://github.com/dendronhq/dendron/issues/152>
185
+ - query by attributes with logical operators: <https://github.com/dendronhq/dendron/issues/159>
186
+
187
+ We also want to support some subset of the queries as note references so that the results can be included in page.
188
+
189
+ ## Other
190
+
191
+ ### Why are there `root` files in my notes?
192
+
193
+ When you initialize a vault, `root.md` and `root.schema.yml` get created inside each vault.
194
+
195
+ They serve as the "roots" of your vault for your notes and schema respectively.
196
+
197
+ root.md is used as the parent of all hierarchies, root.schema as the parent of all schemas
198
+
199
+ root.md is what shows up when you do a lookup with an empty line ""
200
+
201
+ root.schema.yml is a schema that is global for all hierarchies (normally, a schema is scoped to a particular hierarchy)
202
+
203
+ Now this isn't required per-say, we could just do away with **root** notes and stick strictly to hierarchies and this might be an option in the future but this is the reasoning at the current time
204
+
205
+ ps. root.schema.yml doesn't work right now as described in the sense that we haven't implemented global schemas yet
206
+
207
+ ### Can I use a dark theme for the markdown preview?
208
+
209
+ Yes. There's a setting called `markdown-preview-enhanced.previewTheme` that you can set which has a list of default themes, including dark themes.
210
+
211
+ ### Can I customize the markdown preview CSS?
212
+
213
+ Yes. Read [this](https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css) for more information.
214
+
215
+ ### Is there a list of keyboard shortcuts I can see?
216
+
217
+ Dendron has a list of keyboard shortcuts that you can access using `Dendron: Show Help` command. Note that these only show the commands that come with the Dendron Plugin but not its bundled extensions. We currently have an open [issue](https://github.com/dendronhq/dendron/issues/148) to list all shortcuts on one page.
218
+
219
+ ### Why are there '+' signs next to the notes in the Tree View?
220
+
221
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/faq.plus-sign.jpg)
222
+
223
+ The reason you see this is because Dendron will create [[stub|dendron.concepts#stubs]] notes when creating notes that have parents that don't exist. These notes are placeholders and will only be visible in the Dendron Tree View with a `+` sign next to the name. The reason we do stubs is because we don't want to litter your file system with empty files. Stubs are a compromise - they let you see the hierarchy of your newly created notes without forcing you to create intermediary files.
224
+
225
+ ### Why custom markdown preview instead of the VSC one?
226
+
227
+ Our custom markdown preview gives us much more functionality then the vscode one -> eg. note references, checkboxes, etc.
228
+
229
+ In addition, the markdown preview that Dendron uses is platform agnostic (eg. it's also available on atom). This means that other editors could potentially adopt it as well.
230
+
231
+ ### VSCode Snippets are not working in Frontmatter
232
+
233
+ The default snippets are scoped to markdown. You can create [global snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets) file to have snippets that work across all languages.
234
+
235
+
236
+ ### The extension 'Dendron Markdown Preview Enhanced' took a very long time to complete its last operation
237
+
238
+ This is a known issue whenever we release a new version of the preview (mostly because its uncompressed javascript). Moving forward, we'll be removing the dependency on an external plugin and integrating Dendron's markdown features into vscode's native markdown preview in the near future.

Added: vault/dendron.features.md

Files changed (1) hide show
  1. vault/dendron.features.md +142 -0
vault/dendron.features.md ADDED
@@ -0,0 +1,142 @@
1
+ ---
2
+ id: 4bb85c39-d8ac-48ad-a765-3f2a071f7bc9
3
+ title: Features
4
+ desc: ''
5
+ updated: 1614612734259
6
+ created: 1596320368075
7
+ stub: false
8
+ nav_order: 2
9
+ ---
10
+ ## Hierarchies
11
+
12
+ Dendron proposes **hierarchies** as the **human solution** to information overload. This is because there are few things as effective as a multi-level hiearchy for quickly filtering an overwhelming amount of information to something humans can work with. You can read [this blog post](https://www.kevinslin.com/notes/e1455752-b052-4212-ac6e-cc054659f2bb.html) for the extended rationale behind this.
13
+
14
+ In Dendron, you can quickly **lookup** related notes by their hierarchy. Hierarchies are simply `.` delimited filenames, similar to the hierarchies made by domain names (eg. `github.com`).
15
+
16
+ The following are a few notes that have this hierarchical naming format.
17
+
18
+ ```
19
+ - cli.tar.md
20
+ - cli.tar.env.md
21
+ - cli.curl.md
22
+ - cli.dig.md
23
+ ```
24
+
25
+ ## Lookup
26
+
27
+ **Lookup** is the process of finding a note by traversing its hierarchy.
28
+
29
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-cli.gif)
30
+
31
+ > Lookups are **quick**
32
+
33
+ What's nice about using the `.` delimited format is that a note **can be** both **a file** (something that contains data) and **a folder** (something that contains other files) **at the same time**.
34
+
35
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-folder_and_file.gif)
36
+
37
+ > You **can** be a file and have your folder **too**
38
+
39
+ Dendron uses fuzzy matching on paths so you don't have to type out the whole path.
40
+
41
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-fuzzy.gif)
42
+
43
+ > Lazyness is the key to success
44
+
45
+ You can use **lookup** to figure out what is true!
46
+
47
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-bool.gif)
48
+
49
+ ## Schemas
50
+
51
+ If you're paying close attention, you might have noticed some icons popup during lookup.
52
+
53
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-closeup.jpg)
54
+
55
+ These icons indicate the **schema** associated with the note. Think of schemas as an **optional type system** for your information. They describe the hierarchy of your notes and are themselves, represented as a hierarchy.
56
+
57
+ You can create a schema by adding a YAML file with the following naming scheme `{name}.schema.yml` to your workspace.
58
+
59
+ Below is an example of a three-level hierarchy describing cli commands. You don't need to concern yourself with the details of the schema syntax just yet, just know that this schema will match the following [glob patterns](https://facelessuser.github.io/wcmatch/glob/): `cli.*`, `cli.*.cmd`, `cli.*.cmd.*`, `cli.*.env`
60
+
61
+ ```yml
62
+ - id: cli
63
+ desc: command line interface reference
64
+ parent: root
65
+ namespace: true
66
+ children:
67
+ - cmd
68
+ - env
69
+ - id: env
70
+ desc: variables relevant for command
71
+ - id: cmd
72
+ desc: subcommands
73
+ namespace: true
74
+ ```
75
+
76
+ Schemas help you organize your notes by letting you know what comes next.
77
+
78
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-suggest.gif)
79
+
80
+ The `+` sign next to the suggestion indicates that the note does not exist but is part of the schema.
81
+
82
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-plus.jpg)
83
+
84
+ **Schema suggestions** don't show you an endless lineup of tags or folders - they only show you suggestions scoped to your specific level of the hierarchy that you are looking at.
85
+
86
+ The nice thing about these suggestions is that you can also ignore them.
87
+
88
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-ignore.gif)
89
+
90
+ > Sometimes ~~rules~~ schemas are meant to be broken
91
+
92
+ Dendron will show you a `?` next to the result in future results but otherwise will assume that you know best.
93
+
94
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-question.jpg)
95
+
96
+ ## VS Code
97
+
98
+ Dendron is built on top of VSCode, the open-source IDE from Microsoft.
99
+
100
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/code-banner.jpg)
101
+
102
+ Dendron runs as a plugin inside VSCode. If you use VSCode today, it means that all your current knowledge, settings and extensions will carry over into Dendron. If you don't, no sweat, because Dendron will create an optimal workspace with recommended settings and extensions when you first launch it.
103
+
104
+ ## Recommended Extensions
105
+
106
+ Since Dendron runs on top of VSCode, it means that you also have access to thousands of extensions to customize Dendron exactly how you like it.
107
+
108
+ By default, Dendron will initialize your first workspace with the following extensions and features.
109
+
110
+ - [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
111
+ - [wiki links](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
112
+ - [tags](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
113
+ - [backlinks](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) (think Roam)
114
+ - [Markdown Shortcuts](https://marketplace.visualstudio.com/items?itemName=mdickin.markdown-shortcuts)
115
+ - Quickly toggle bullet points
116
+ - Easily generate URLs
117
+ - Convert tabular data to tables
118
+ - [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
119
+ - [live markdown preview](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
120
+ - [math](https://shd101wyy.github.io/markdown-preview-enhanced/#/math) (KaTeX or MathJax)
121
+ - [sequence diagrams](https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams?id=mermaid) (mermaid)
122
+ - [pandoc support](https://shd101wyy.github.io/markdown-preview-enhanced/#/pandoc)
123
+ - [code chunks](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk)
124
+ - [presentations](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html)
125
+ - [Material Theme](https://marketplace.visualstudio.com/items?itemName=equinusocio.vsc-material-theme)
126
+ - beautiful colors built using the [Material design system](https://material.io/)
127
+ - [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
128
+ - easily add images from your clipboard to your markdown files
129
+ - [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
130
+ - Spell Check
131
+
132
+ ## Additional Features
133
+
134
+ The following extensions also work well with Dendron but are not bundled by default. You can download them separately to unlock additional functionality.
135
+
136
+ - [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) 🔍
137
+ - Repository/File/Line history and annotations of all your files
138
+ - [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim)
139
+ - VIM key bindings 😍
140
+ - [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks)
141
+ - Bookmark lines within files
142
+

Added: vault/dendron.guides.cook.md

Files changed (1) hide show
  1. vault/dendron.guides.cook.md +313 -0
vault/dendron.guides.cook.md ADDED
@@ -0,0 +1,313 @@
1
+ ---
2
+ id: 401c5889-20ae-4b3a-8468-269def4b4865
3
+ title: Cookbook
4
+ desc: ''
5
+ updated: 1615132368125
6
+ created: 1595952505024
7
+ nav_order: 8.9
8
+ toc: true
9
+ ---
10
+ ## General
11
+
12
+ ### Manual Install
13
+
14
+ To manually install a custom version of Dendron, first obtain the Dendron vsix file (most likely, Kevin will send you a dropbox link 😅). Afterwards, you can install it by the extended options in the extensions pane.
15
+
16
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble.install.gif)
17
+
18
+ ### Checking Logs
19
+
20
+ You can diagnose most problems by checking the logs. You can view the logs using the [[Open Logs Command|dendron.topic.commands#dendrondev-open-logs]]
21
+
22
+ #### Server Logs
23
+
24
+ Dendron has two sets of logs - client and server. The client logs you can access using the `Open Logs Command`. You can access the server logs by following the tutorial [here](https://www.loom.com/share/3d04cb1d6f904ac099d73e083e62ee2f).
25
+
26
+ #### Logs from previous session
27
+
28
+ Dendron has logs for the current session and the previous session.
29
+
30
+ You can get logs of the previous session by following instructions [here](https://www.loom.com/share/2ca740e8e09b4aaf927d8098e2e6dec0)
31
+
32
+ ## Bucket
33
+
34
+ ### Star/Favorite/Pin Notes
35
+
36
+ Dendron doesn't currently provide native support for this. You can download the [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks) extension to achieve the functionality in the interim.
37
+
38
+ ### Launch the command bar
39
+
40
+ This lets you execute commands inside vscode
41
+
42
+ - Linux: `Ctrl+Shift+P`
43
+ - macOS: `Cmd+Shift+P`
44
+ - Windows: `Ctrl+Shift+P`
45
+
46
+ ### Analyze notes using elasticsearch
47
+
48
+ - WARNING: this is advanced material
49
+
50
+ With Dendron, you can export your notes using the [[JSON Export Pod|dendron.topic.pod]] and then use that data to analyze your notes using elasticsearch.
51
+
52
+ This video walkthrough walks you through that process.
53
+ <a href="https://www.loom.com/share/c85c7c81d8aa4e97b4bbdf2245ca8f9b"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c85c7c81d8aa4e97b4bbdf2245ca8f9b-with-play.gif"> </a>
54
+
55
+ You can download the repo used in this walkthrough from [github](https://github.com/dendronhq/sample-elasticsearch-demo)
56
+
57
+ Pre-requisites:
58
+
59
+ - download and run elasticsearch
60
+
61
+ Steps:
62
+
63
+ 1. Export your data using the JSON Export Pod
64
+ 2. Create an index in elasticsearch (we're using version 7.9)
65
+
66
+ ```json
67
+ PUT notes
68
+ {
69
+ "mappings": {
70
+ "properties": {
71
+ "created": {
72
+ "type": "date",
73
+ "format": "epoch_millis"
74
+ }
75
+ }
76
+ }
77
+ }
78
+ ```
79
+
80
+ 3. Pipe exported JSON into the newly created index.
81
+
82
+ ```bash
83
+ cat /path/to/exported/notes.json | jq -c '.[] | {"index": {"_index": "notes", "notes", "_id": .id}}, .' | curl -H'Content-Type: application/json' -XPOST localhost:9200/_bulk --data-binary @-
84
+ ```
85
+
86
+ 4. Profit!
87
+
88
+ Some potential use cases you can do using elasticsearch and Dendron:
89
+
90
+ - filter your notes by any logical combination of custom attributes
91
+ - make a heatmap of notes created by date
92
+ - get a full list of tags used across your vault and on a per hierarchy basis
93
+ - anything else you can thin of :)
94
+
95
+ Some useful additional links:
96
+
97
+ - [elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html)
98
+ - [elasticsearch vscode extension](https://marketplace.visualstudio.com/items?itemName=ria.elastic)
99
+
100
+ ### Convert timestamps in the frontmatter
101
+
102
+ Currently, Dendron notes show timestamps in epoch time which is not the most parsable for humans. You can use the [timestamp converter extension](https://marketplace.visualstudio.com/items?itemName=Stalinbalraj.timestamp-converter) order to see a human representation of said timestamp.
103
+
104
+ ### Use Dendron with Anki
105
+
106
+ - [Anki for VSCode](https://marketplace.visualstudio.com/items?itemName=jasew.anki)
107
+
108
+ ### Use Dendron on a separate instance of VS Code
109
+
110
+ You can use Dendron on a separate instance of VS Code by launching it with the [command line flags](https://code.visualstudio.com/docs/editor/command-line#_advanced-cli-options) `--user-data-dir` and `--extensions-dir`:
111
+
112
+ ```
113
+ code --user-data-dir=/path/to/code-dendron --extensions-dir=/path/to/code-dendron-ext
114
+ ```
115
+
116
+ ### Mobile Support
117
+
118
+ Dendron does not have a dedicated mobile client at this time. There are numerous mobile markdown editors that can be used to view and edit Dendron notes. Some popular options are listed below:
119
+
120
+ - [Git Journal](https://github.com/GitJournal/GitJournal)
121
+ - [iA Writer](https://ia.net/writer)
122
+ - [Epsilon Notes](https://play.google.com/store/apps/details?id=com.ekartoyev.enotes&hl=en_US&gl=US)
123
+ - [Neutrinote](https://neutrinote.wordpress.com/) (Android only)
124
+
125
+ Most mobile apps do not have git support.
126
+
127
+ - If you are on iOS, you can follow the instructions [here](https://victoria.dev/blog/a-remote-sync-solution-for-ios-and-linux-git-and-working-copy/) to sync your git backed Dendron with any note taking tool on iOS.
128
+ - If you are on Android, you can read [this writeup](https://mstempl.netlify.app/post/working-with-git-on-android/) by one of users on having Git Sync on Android devices
129
+
130
+ ### WebClipper
131
+
132
+ You can use the [markdownload-markdown-web](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi) extension to clip content as markdown from Chrome.
133
+
134
+ ### Regex
135
+
136
+ To get familiar with regex syntax, try [regexr](https://regexr.com/) is a great place to experiment with different queries.
137
+
138
+ ### Convert Local Vault to a Remote Vault
139
+
140
+ 1. Initialize local vault as a git repo and push it to a remote
141
+ 2. Remove the local vault from your current workspace
142
+ 3. Use the `Vault: Add` command and enter the remote url of the repo you would like to add
143
+
144
+ ### Automatically Convert Casing on a Note
145
+
146
+ You can use the [string converter](https://marketplace.visualstudio.com/items?itemName=adamwalzer.string-converter) extension to change `[[normal note with spaces]]` to `[[normal-note-with-spaces]]` as well as a series of other text transformations.
147
+
148
+ ## Markdown Preview
149
+
150
+ ### Prevent newly opened files from replacing the preview pane?
151
+
152
+ Set the following option in your workspace settings
153
+
154
+ ```json
155
+ "markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
156
+ ```
157
+
158
+ ### Customize Theme
159
+
160
+ To change the color theme, you can update the `markdown-preview-enhanced.previewTheme` vscode setting
161
+
162
+ ### Customize CSS
163
+
164
+ You can see instructions for customizing css [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css)
165
+
166
+ ## VSCode
167
+
168
+ ### Use Dendron with a current folder
169
+
170
+ - 1. start by initializing a workspace
171
+
172
+ ((ref:[[dendron.topic.commands]]#initialize workspace:#*))
173
+
174
+ - 2. by default, dendron uses a `vaults` folder underneath your workspace to store you vaults. Update your [[settings|dendron.guides.settings]] and change `vault` to the path of your current notes (alternatively, you can also copy your current notes into `vault`)
175
+
176
+ ```
177
+ "folders": [
178
+ {
179
+ "path": "vault"
180
+ },
181
+ ...
182
+ ],
183
+ ```
184
+
185
+ - 3. Run `> Dendron: Reload Index` for Dendron to pick up changes
186
+
187
+ ### Access Dendron Workspace from multiple windows
188
+
189
+ There are usually two scenarios:
190
+
191
+ 1. you want two windows of different workspaces
192
+ 2. you want two windows of the same workspace
193
+
194
+ - for 1, create a new window and initialize a new workspace in some directory that is different from your first workspace
195
+ - for 2, you have a few options
196
+ - a. initialize a new workspace in a different directory. open the settings using `> Open User Workspace settings (JSON)`. change the folder to the path of your vault in the initial workspace. run `> Reload Window` for the changes to take affect
197
+ - b. use a different version of vscode to open the same workspace (eg. vscode insider, vscodium, vscode regular). you need to do this because vscode will re-use the same window when opening the same workspace
198
+
199
+ ### Change the sorting order in the Outline Panel
200
+
201
+ Click the three little dots next to outline to change the sorting order. You can sort by **Name** (alphabetical) or **Position** (linear order)
202
+
203
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/cook.vscode.outline.jpg)
204
+
205
+ ### Change the sorting oder in the Explorer Panel
206
+
207
+ See instructions [here](https://stackoverflow.com/questions/51543871/sorting-files-in-vs-code-explorer)
208
+
209
+ ### Drag and Drop files into Dendron
210
+
211
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/cook.drag.jpg)
212
+
213
+ To drag files into Dendron, open the workspace pane on the side to drag and drop. We currently recommend you only do this for non-markdown files that you want to link to inside your vaults.
214
+
215
+ ### Find Installed Extensions
216
+ 1. Navigate to the extensions pane
217
+ 1. Search for `@installed`
218
+
219
+ ## Navigation
220
+
221
+ ### Enable Table of Contents
222
+
223
+ When viewing your notes locally, you can view the toc either from the outline view or by toggling the preview
224
+
225
+ - from the outline
226
+ ((ref:[[dendron.topic.workbench]]#outline view,1:#*))
227
+
228
+ - from the preview
229
+ ((ref:[[dendron.topic.preview]]#table of contents,1))
230
+
231
+ ## Publishing
232
+
233
+ ### Incremental Builds
234
+
235
+ You can do incremental builds from Jekyll and Dendron
236
+
237
+ - when previewing the site locally, add the `incremental` flag
238
+ ```bash
239
+ bundle exec jekyll s --watch --incremental
240
+ ```
241
+ - when building the site, also add an incremental flag
242
+ - NOTE: you'll need `rsync` installed to use the incremental flag
243
+
244
+ ```bash
245
+ dendron-cli buildSite --wsRoot {path/to/ws} --vault {path/to/vault} --incremental
246
+ ```
247
+
248
+ ### Automatically Update Site while editing
249
+
250
+ The following instructions cover how to update your local preview everytime you make a change to your notes
251
+
252
+ - install `dendron-cli`
253
+ ((ref:[[dendron.topic.cli]]#installation,1:#*))
254
+
255
+ - have jekyll watch your site-root
256
+
257
+ ```bash
258
+ cd {your-site-root}
259
+ bundle exec jekyll s --watch
260
+ ```
261
+
262
+ - use `nodemon` to watch your vault
263
+
264
+ ```bash
265
+ npm install -g nodemon
266
+ nodemon --watch {path/to/vault} --ext md dendron-cli buildSite --wsRoot {path/to/ws} --vault {path/to/vault}
267
+ ```
268
+
269
+ - NOTE: you can combine this with incremental builds to have the best editing experience
270
+
271
+ ### Publish password protected site using AWS Amplify
272
+
273
+ You can click [here](https://main.d19svbygngqnpb.amplifyapp.com/) to see a demo of the end result.
274
+
275
+ You can access the site with username: `dendron`, password: `hierarchy`.
276
+
277
+ - NOTE: this requires hosting your site on AWS. For most people, this will end up costing you a few cents a month.
278
+
279
+ #### Setup your github repo
280
+
281
+ 1. Create a new github repo using this [template](https://github.com/dendronhq/dendron-amplify-template/generate).
282
+ 2. In your Dendron workspace, remove the `docs` directory and clone your newly created repository
283
+ ```bash
284
+ cd {your-workspace}
285
+ rm -r docs
286
+ git clone {your-repo} docs
287
+ ```
288
+
289
+ #### Setup aws
290
+
291
+ 1. Create an [aws account](https://aws.amazon.com/)
292
+ 2. Login to your AWS account and go select the [Amplify Service](https://us-west-2.console.aws.amazon.com/amplify/home?region=us-west-2#/)
293
+ - ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/amplify.select.jpg)
294
+ 3. Follow the instructions [here](https://docs.aws.amazon.com/amplify/latest/userguide/getting-started.html) to connect your github with your amplify
295
+ 4. Follow the instructions [here](https://docs.aws.amazon.com/amplify/latest/userguide/access-control.html) to restrict access to your site.
296
+ 5. Verify that your site is now password protected
297
+
298
+ #### Publish your notes
299
+
300
+ 1. Update `siteRepoDir` in `dendron.yml` with the location of your github directory
301
+ - Your `dendron.yml` should look similar to the one below
302
+ ```yml
303
+ site:
304
+ copyAssets: true
305
+ siteHierarchies:
306
+ - root
307
+ siteRootDir: docs
308
+ usePrettyRefs: true
309
+ siteRepoDir: docs
310
+ ```
311
+ 2. Run `> Dendron: Publish` to build your notes for publication and push your notes
312
+ 3. Your notes are now published privately behind a password
313
+

Added: vault/dendron.guides.install.md

Files changed (1) hide show
  1. vault/dendron.guides.install.md +33 -0
vault/dendron.guides.install.md ADDED
@@ -0,0 +1,33 @@
1
+ ---
2
+ id: d95b93bf-5e6f-4dd0-b7d7-c8e29e061876
3
+ title: Getting Started
4
+ desc: ''
5
+ updated: 1608485512284
6
+ created: 1595537796868
7
+ ---
8
+ [Ed](https://www.youtube.com/channel/UCBDaEQKIAgU-U6bsUfPcWnA), our fellow Dendrologist, has made a fantastic getting started video to help folks install and setup Dendron.
9
+
10
+ <iframe width="560" height="315" src="https://www.youtube.com/embed/BRLLZ9IEh10" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
11
+
12
+ # Install
13
+
14
+ Dendron can be installed as a [vscode plugin](https://marketplace.visualstudio.com/items?itemName=dendron.dendron). If you don't already have VSCode, you can download it [here](https://code.visualstudio.com/).
15
+
16
+ After you have downloaded the plugin, following the instructions to create your first **workspace**.
17
+
18
+ 1. With VSCode in focus, launch the _command bar_:
19
+
20
+ ((ref:[[dendron.guides.cook]]#launch the command bar,3:#*))
21
+
22
+ 2. Paste the following command and press `Enter`:
23
+
24
+ ```bash
25
+ > Dendron: Initialize Workspace
26
+ ```
27
+
28
+ 3. Select a folder that will act as the root of your dendron workspace.
29
+
30
+ ![Initialize workspace](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/dendron-init.gif)
31
+
32
+ When the workspace opens, it will show dialogue to install the recommended extensions. Though not required, these extensions add all the **non-core** features of Dendron like wiki links and tagging support.
33
+

Added: vault/dendron.guides.md

Files changed (1) hide show
  1. vault/dendron.guides.md +10 -0
vault/dendron.guides.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 02c2d7b6-2ea2-4e15-9894-9dead50d5ca2
3
+ title: Guides
4
+ desc: ''
5
+ updated: 1604237878745
6
+ created: 1604237852460
7
+ nav_order: 7
8
+ ---
9
+ Resources to help you with using Dendron.
10
+

Added: vault/dendron.guides.migration.md

Files changed (1) hide show
  1. vault/dendron.guides.migration.md +29 -0
vault/dendron.guides.migration.md ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ id: f9b4fc21-7613-4c8a-9257-cec4c06b67f9
3
+ title: Migration
4
+ desc: ''
5
+ updated: 1607277962381
6
+ created: 1603982164242
7
+ ---
8
+ This note covers migrating your notes from other tools
9
+
10
+ ## Obsidian
11
+
12
+ 1. Use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to import your notes into Dendron
13
+
14
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b2cb9672c6814ae5b149eae8e3fbca0b" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
15
+
16
+ ## One Note
17
+
18
+ 1. [Convert one note files to markdown](https://itectec.com/superuser/how-to-export-all-onenote-pages-to-individual-markdown-files/)
19
+ 2. Use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to import your notes into Dendron
20
+
21
+ ## Importing Files
22
+
23
+ Once Dendron is initialized, to import an individual markdown file to your Dendron project.
24
+
25
+ 1. drag the markdown file into VSCode
26
+ 2. run `Dendron Doctor`so Dendron recognizes the imported file.
27
+
28
+ The second step will add some front matter to the head of the file.
29
+

Added: vault/dendron.guides.settings.md

Files changed (1) hide show
  1. vault/dendron.guides.settings.md +14 -0
vault/dendron.guides.settings.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ id: 26d66e84-6e4f-4688-bf6e-af070def7c38
3
+ title: Settings
4
+ desc: ''
5
+ updated: 1604238328894
6
+ created: 1600729806764
7
+ ---
8
+ You can update Dendron settings by using the VSCode workspace settings by using the command prompt to `Preferences: Open Workspace Settings`
9
+
10
+ <a href="https://www.loom.com/share/2d8eaeb6fddf4c76a390d3894b497435">
11
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/2d8eaeb6fddf4c76a390d3894b497435-with-play.gif"> </a>
12
+
13
+ If you are comfortable with editing raw JSON, you can use `Preferences: Open Workspace Settings (JSON)` to work with the settings in raw JSON
14
+

Added: vault/dendron.guides.tips.md

Files changed (1) hide show
  1. vault/dendron.guides.tips.md +422 -0
vault/dendron.guides.tips.md ADDED
@@ -0,0 +1,422 @@
1
+ ---
2
+ id: 692fa114-f798-467f-a0b9-3cccc327aa6f
3
+ title: Tips
4
+ desc: ''
5
+ updated: 1612800748642
6
+ created: 1595614204291
7
+ ---
8
+
9
+ ## Bucket
10
+
11
+ ### Peeking
12
+
13
+ It is possible to [peek](https://code.visualstudio.com/docs/editor/editingevolved#_peek) at wiki-links in Dendron. This lets you see content without actually navigating to the page.
14
+
15
+ <a href="https://www.loom.com/share/2289613674ac4a4183ed5db8630120dc">
16
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/2289613674ac4a4183ed5db8630120dc-with-play.gif">
17
+ </a>
18
+
19
+
20
+ ### Moving Lines
21
+
22
+ When working with lines, you can move entire lines at a time using `option-up|down` shortcut on mac. This is really helpful for prioritizing todos among other things ✅
23
+
24
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips-move-lines.gif)
25
+
26
+ ### Search Editor
27
+
28
+ - [docs](https://code.visualstudio.com/updates/v1_43#_search-editors)
29
+
30
+ Also known as the coolest feature in vscode that most people have never heard of. This lets you view and save your search results in a full blown text editor. You can combine it with Dendron's hierarchies to do some amazing things, like aggregating all your todos.
31
+
32
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.search-editor.gif)
33
+
34
+ You can open search editor via keyboard shortcut. I use it to start a search with the current filename. works really well with Dendron hierarchies.
35
+
36
+ ```json
37
+ {
38
+ "key": "ctrl+s f",
39
+ "command": "search.action.openNewEditor",
40
+ "args": {
41
+ "query": "",
42
+ "triggerSearch": false,
43
+ "focusResults": false,
44
+ "includes": "${fileBasenameNoExtension}",
45
+ }the following line
46
+ }
47
+ ```
48
+
49
+ ### Stylized Tags Using Custom CSS
50
+
51
+ To customize the look and feel of your tags, you can do so by using the following convention and [CSS edits](https://www.dendron.so/notes/683740e3-70ce-4a47-a1f4-1f140e80b558.html#can-i-customize-the-markdown-preview-css).
52
+
53
+ Let's say you have a `books` hierarchy and you have a `books.high-growth-handbook` note. You have all the tags you use for books under a `books.tags.` namespace.
54
+
55
+ If you use links for tags: `[[#business|books.tags.business]]`, you can use this CSS to customize their look:
56
+
57
+ ```css
58
+ /* General tag styling */
59
+ a[href*=".tags."] {
60
+ color: #000;
61
+ background: #fff;
62
+ display: inline-block;
63
+ padding: 0 10px;
64
+ border-radius: 4px;
65
+ }
66
+ /* Customizing the look of specific tags */
67
+ a[href*=".tags.business"] {
68
+ color: #fff;
69
+ background: rgb(36, 89, 233);
70
+ }
71
+ ```
72
+
73
+ The result looks like this:
74
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tags.png)
75
+
76
+ ### Collapsing Headers and Bullets
77
+
78
+ You can collapse headers at different levels and bullets at different indentation levels inside VSCode.
79
+
80
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.toggle-bullets.gif)
81
+
82
+
83
+ ### Create a new note in a deeply nested hierarchy
84
+ - [discord thread](https://discordapp.com/channels/717965437182410783/735365126227493004/758235198403117087)
85
+
86
+ - Problem:
87
+ - You are currently in `foo` and you want to create the note `foo.child1.child2.my-note`. You don't want to type out the full path. Is there an easier way to create `my-note` than typing out the full path?
88
+ - Solution:
89
+ - VSCode doesn't support autocomplete inside the quick input widget which Dendron uses for lookups. We are experimenting with different ways of getting around this.
90
+ - Today, the workaround is to create a wiki-link inside another note and navigate via link to create it.
91
+ - Another method, if you know you will be creating multiple children under a single deeply nested parent, is to pin the parent and create the child from the parent
92
+
93
+ <a href="https://www.loom.com/share/f0bbfc9cae0a474a99f8a1169b7b96c7">
94
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/f0bbfc9cae0a474a99f8a1169b7b96c7-with-play.gif"> </a>
95
+
96
+
97
+ ### Automate Git Tasks
98
+ - [discord thread](https://discordapp.com/channels/717965437182410783/742532267058004098/759130627781558403)
99
+ - Problem:
100
+ - You want an easier way to `git add && git commit && git push`
101
+ - Solution
102
+ - Use [git automator](https://marketplace.visualstudio.com/items?itemName=ivangabriele.vscode-git-add-and-commit).
103
+
104
+ ### Publish to GitHub Pages with Actions
105
+
106
+ - [discord thread](https://discordapp.com/channels/717965437182410783/749641193322971238/759190468671438848)
107
+
108
+ It's possible to publish your Dendron site to GitHub Pages without the shadow copy of your notes in the `docs` directory.
109
+
110
+ You can create a GitHub Actions workflow to perform the export process using the Dendron CLI and push the result to your `pages` branch, triggering a Pages build.
111
+
112
+ Note that this configuration won't retain any history on the `paths` branch. Paths below are relative to your workspace root.
113
+
114
+ Ignore the shadow directories in `.gitignore`:
115
+
116
+ ```
117
+ gitignore
118
+ # Dendron
119
+ /docs/assets/
120
+ /docs/notes/
121
+ /docs/_site/
122
+
123
+ # npm
124
+ /node_modules/
125
+ ```
126
+
127
+ Create a `package.json` to install the package:
128
+
129
+ ```json
130
+ {
131
+ "scripts": {
132
+ "dendron-cli": "dendron-cli"
133
+ },
134
+ "repository": {
135
+ "type": "git",
136
+ "url": "git+https://github.com/LukeCarrier/brain.git"
137
+ },
138
+ "license": "UNLICENSED",
139
+ "devDependencies": {
140
+ "@dendronhq/dendron-cli": "^0.12.3-alpha.16"
141
+ }
142
+ }
143
+ ```
144
+
145
+ Create the workflow `.github/workflows/dendron.yml`:
146
+
147
+ ```yaml
148
+ name: Dendron
149
+
150
+ on:
151
+ push:
152
+ branches:
153
+ - master
154
+
155
+ jobs:
156
+ build:
157
+ runs-on: ubuntu-latest
158
+ steps:
159
+ - name: Checkout source
160
+ uses: actions/checkout@v2
161
+
162
+ - name: Install npm dependencies
163
+ run: npm install
164
+
165
+ - name: Build pod
166
+ run: npm run dendron-cli -- buildSite --wsRoot ./ --vault notes/
167
+
168
+ - name: Deploy site
169
+ uses: peaceiris/actions-gh-pages@v3
170
+ with:
171
+ github_token: ${{ secrets.GITHUB_TOKEN }}
172
+ publish_branch: pages
173
+ publish_dir: docs/
174
+ force_orphan: true
175
+ enable_jekyll: true
176
+ ```
177
+
178
+ Configure your repository's Pages settings as follows:
179
+
180
+ * _Branch_: `pages`
181
+ * _Folder_: _/ (root)_
182
+
183
+ Finally, commit these three files and push them to your `master` branch. Within a few seconds you should see the workflow run, your `pages` branch get updated and your Pages build start.
184
+
185
+ ### Go back to previous Note
186
+
187
+ Use "> Quick Open Previous Recently Used...` to navigate through recently opened notes
188
+ - default shortcut: `CTRL-TAB`
189
+
190
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.most-recent.gif)
191
+
192
+
193
+ ### Keep Track of Tabs
194
+
195
+ It's really easy to lose sight of your tabs, especially with menu items occluding the little horizontal space you have for tabs.
196
+
197
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.nav.jpg)
198
+
199
+ Instead of relying on the menu, you can use `Show All Editors` to see all tabs via a dropdown. You can also narrow down tabs after selection.
200
+
201
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.editors.gif)
202
+
203
+ You can streamline this process by assigning a keyboard shortcut to the command. Below is an example.
204
+ ```json
205
+ {
206
+ "key": "ctrl+t",
207
+ "command": "workbench.action.showAllEditors"
208
+ }
209
+ ```
210
+
211
+
212
+ ### Copy and Paste Web Content into Dendron
213
+
214
+ First copy it into Notion or use the notion web clipper to clip it. This will format it nicely in markdown. You can then paste it into Dendron with markdown and everything :)
215
+
216
+ <!--
217
+
218
+ ### Custom Outlines
219
+
220
+ TODO: need to add more details
221
+
222
+ Outlines are super helpful but there are not always feasible depending on the file format
223
+
224
+ ![](/assets/images/2020-09-21-19-33-21.png)
225
+
226
+ In those situations, I like to leave markers inside a note and use the search editor to surface those markers
227
+
228
+ <a href="https://www.loom.com/share/eabf90dbc74e4a1facd5e82bd76a6134">
229
+ <p>Tips - Breadcrumbs - Watch Video</p>
230
+ <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/eabf90dbc74e4a1facd5e82bd76a6134-with-play.gif"> </a>
231
+
232
+ https://www.loom.com/share/eabf90dbc74e4a1facd5e82bd76a6134
233
+
234
+ You can use the same technique
235
+
236
+ # Generating all journal notes ahead of time
237
+
238
+ https://stackoverflow.com/questions/25701265/how-to-generate-a-list-of-all-dates-in-a-range-using-the-tools-available-in-bash
239
+ -->
240
+
241
+ ## Workbench
242
+
243
+ ### Navigating a hierarchy
244
+
245
+ One easy way of navigating hierarchies it to click on the file name. This will reveal a dropdown that shows you all siblings of the current note.
246
+
247
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/guide.siblings.jpg)
248
+
249
+ ### Remove Markdown Buttons in Menu Bar
250
+ - [discord thread](https://discordapp.com/channels/717965437182410783/739186036495876126/758408534848831558)
251
+
252
+ ```json
253
+ "markdownShortcuts.icons.bold": false,
254
+ "markdownShortcuts.icons.italic": false,
255
+ "markdownShortcuts.icons.strikethrough": false,
256
+ "markdownShortcuts.icons.bullets": false,
257
+ ```
258
+
259
+ ### Moving Panes
260
+
261
+ You can move vscode tabs using the following builtin commands:
262
+ - `View: Move Editor Into Next Group`
263
+ - `View: Move Editor Into Previous Group`
264
+
265
+ They are mapped on to the following keyboard shortcuts:
266
+ - mac: `cmd+ctrl+left|right`
267
+
268
+ This is helpful for looking at your notes side by side.
269
+
270
+ <a href="https://www.loom.com/share/d99ec9cce8ff4d869cf8c36955152808">
271
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/d99ec9cce8ff4d869cf8c36955152808-with-play.gif"> </a>
272
+
273
+ ### Pinning Tabs
274
+
275
+ You can pin tabs in VSCode by right clicking on a tab and selecting `Pin Tab`.
276
+
277
+ The latest VSCode lets you control pin behavior for tabs. It's not currently documented as of 2020.09.28 but as of the latest insider build, it has a few different options to control the pinned behavior.
278
+
279
+ - options:
280
+ - normal (default), normal tab size with a pin icon
281
+ - shrink: reduced tab size with some text visible
282
+ - compact: only icon visible
283
+
284
+ ```json
285
+ "workbench.editor.pinnedTabSizing": "shrink"
286
+ ```
287
+
288
+
289
+ ### Zen Mode
290
+
291
+ VSCode can be visually noisy. You can hide most of the UI by toggling `Zen Mode` with a three panel layout.
292
+
293
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.zen.jpg)
294
+
295
+ The following setting overrides are useful:
296
+
297
+ ```json
298
+ // by default, zen mode will open a new "workspace" which I don't like
299
+ "zenMode.fullScreen": false,
300
+ // I'm a vim user so I like my line numbers
301
+ "zenMode.hideLineNumbers": false,
302
+ ```
303
+
304
+ To navigate tabs and look at the breadcrumb outline, You can use the following commands
305
+
306
+ ```json
307
+ workbench.action.showAllEditors -> (no shortcut by default, consider mapping to ctrl + t)
308
+ breadcrumbs.focusAndSelect -> cmd + t
309
+ ```
310
+
311
+ You can see a video of this workflow in the video below.
312
+
313
+ <a href="https://www.loom.com/share/dd27df6d556d4ba6b28b2028ca7d1455">
314
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/dd27df6d556d4ba6b28b2028ca7d1455-with-play.gif"> </a>
315
+
316
+ ### Always show preview of md being edited
317
+
318
+ Set the following option in your workspace settings
319
+
320
+ ```json
321
+ "markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
322
+ ```
323
+
324
+
325
+ ## Snippets
326
+
327
+ ### Have links auto-complete without additional key presses
328
+
329
+ - Update your settings to the following
330
+ ```json
331
+ // The following settings will only apply to markdown files:
332
+ "[markdown]": {
333
+ // quickSuggestions true will provide suggestions as you type.
334
+ // If you turn this on and DO NOT want suggestions
335
+ // for non-wiki-link, non-tag words,
336
+ "editor.quickSuggestions": true,
337
+ // This is poorly documented, but seems to offer suggestions
338
+ // from any word in open document when turned on, which
339
+ // can be a little distracting in markdown docs:
340
+ "editor.wordBasedSuggestions": false,
341
+ "editor.tabSize": 2,
342
+ // Set this to false if you turn on quickSuggestions
343
+ // but don't want suggestions for markdown related snippets
344
+ // as you type:
345
+ "editor.suggest.showSnippets": false,
346
+ },
347
+ ```
348
+
349
+ ## Markdown
350
+
351
+ ### Always have the preview open
352
+
353
+
354
+ You can add the following setting to your workspace to always have a markdown editor show up with your content.
355
+
356
+ ```json
357
+ "markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
358
+ ```
359
+
360
+ ### Symbol search
361
+
362
+ When using the standard file-search in vscode (`ctrl-P`), you can search for all titles in your workspace if you use the starting keyword `#`
363
+
364
+ Example: if i know i had a header with the title "cheatsheet", i can type in `# cheatsheet`
365
+
366
+ ### Auto bullet list
367
+
368
+ VSCode doesn't support auto-formatting by default. You can use the following workaround to mimic the behavior.
369
+
370
+
371
+ - Add list-item below current position. Using `-`
372
+ ```json
373
+ {
374
+ "key": "shift+enter",
375
+ "command": "type",
376
+ "args": {
377
+ "text": "\r\n- "
378
+ },
379
+ "when": "editorTextFocus && !editorReadOnly && editorLangId == 'markdown'"
380
+ }
381
+ ```
382
+
383
+ - Add list-item below current position. Using `*`
384
+
385
+ ```json
386
+ {
387
+ "key": "shift+enter",
388
+ "command": "type",
389
+ "args": {
390
+ "text": "\r\n* "
391
+ },
392
+ "when": "editorTextFocus && !editorReadOnly && editorLangId == 'markdown'"
393
+ }
394
+ ```
395
+
396
+ > Credit for this recipe goes to @Stigs#0135
397
+
398
+
399
+ ## Other Tools
400
+
401
+ This is a list of other tools that work well with Dendron.
402
+ - [nvAlt](https://brettterpstra.com/projects/nvalt/): local markdown editor that works well with Dendron notes (mac only)
403
+
404
+ ## Other VSCode Extensions
405
+
406
+ ### Git
407
+ - [Git Automator](https://marketplace.visualstudio.com/items?itemName=ivangabriele.vscode-git-add-and-commit): one command to commit and push all changes
408
+ - [Git Doc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc): auto-commit and (optionally) auto push your notes at fixed intervals
409
+ - [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens): Repository/File/Line history and annotations of all your files
410
+ - [Path AutoComplete](https://github.com/ionutvmi/path-autocomplete): Path autocomplete for VSCode
411
+
412
+ ### Other
413
+ - [Macros](https://marketplace.visualstudio.com/items?itemName=geddski.macros): Define custom macros
414
+ - [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim): VIM key bindings 😍
415
+ - [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks): Bookmark lines within File [Vertical Limit](https://marketplace.visualstudio.com/items?itemName=generik.vertical-limit): Work with multiple cursors and blocks of text
416
+ - [CodeUI](https://marketplace.visualstudio.com/items?itemName=ryanraposo.codeui): Easier customization of every part of the VSCode UI
417
+
418
+ ## Other Browser Extensions
419
+
420
+ ### Web Clipper
421
+ - [Markdown Web](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi?hl=en-GB): markdown based web clipper
422
+ - [Roam Highlighter](https://chrome.google.com/webstore/detail/mcoimieglmhdjdoplhpcmifgplkbfibp)

Added: vault/dendron.guides.troubleshooting.md

vault/dendron.guides.troubleshooting.md ADDED
@@ -0,0 +1,147 @@
1
+ ---
2
+ id: a6c03f9b-8959-4d67-8394-4d204ab69bfe
3
+ title: Troubleshooting
4
+ desc: ''
5
+ updated: 1615132375354
6
+ created: 1595952505025
7
+ ---
8
+ ## Diagnosing
9
+
10
+ You can get a better idea of what went wrong by checking out the [[logs|dendron.guides.cook#checking-logs]]. At that point, you should be able to narrow down the root cause to one of the issues below. If not, please bring it up on the [discord](https://discord.gg/AE3NRw9) or file a [bug report](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title=)
11
+
12
+ ## General
13
+
14
+ ### Engine not initialized
15
+
16
+ This is most likely due to the VSCode [workspace file](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_opening-workspace-files) not being open. Make sure to open the **dendron.code-workspace** file by following the instructions [here](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_opening-workspace-files)
17
+
18
+ ### Multiple Vaults with the same name
19
+
20
+ You will get this if you have multiple [[vaults|dendron.topic.config#vaults]] that have the same name. This is an error with Dendron since Dendron requires all vault names be unique. You can fix this by removing the duplicate vaults or setting a unique [[name|dendron.topic.config#name]] property for the vault.
21
+
22
+ ### Notes from the graph/tree view are out of sync
23
+
24
+ Run `Dendron: Reload Index` to manually sync. If that doesn't work, you can also try `Developer: Reload Window` to restart VSCode.
25
+
26
+ ## Upgrading
27
+
28
+ ### Error upgrading
29
+
30
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble.upgrade.png)
31
+
32
+ Dendron will update keybindings/settings/etc to the latest defaults if not currently set on upgrade. If you see the above error, it means that Dendron had trouble parsing one of your settings files. This doesn't stop dendron from starting but it does mean that the latest settings aren't being applied.
33
+
34
+ The most likely culprit of this error is a bad snippets file. To fix, bring up the command prompt, type `>Configure User Snippets`, open `dendron.code-snippets` and see if there's anything funky with the json on the line mentioned by the error. You can also use tools like [jsonlint](https://jsonlint.com/) to validate your JSON.
35
+
36
+ ## Schemas
37
+
38
+ ### I'm getting a `you cannot define a mapping item when in a sequence` when trying to define a schema
39
+
40
+ That means there's an issue with your yaml. You can paste it in [yaml lint](http://www.yamllint.com/) to check that you are using the correct yaml syntax.
41
+
42
+ ### Schema Templates aren't working
43
+
44
+ Schema templates are defined as YAML objects. The most common mistake is putting them down as a list
45
+
46
+ For example, this is a valid schema.
47
+
48
+ ```yml
49
+ - id: journal
50
+ title: journal
51
+ desc: ""
52
+ parent: root
53
+ children:
54
+ - daily
55
+ - id : daily
56
+ namespace: true
57
+ template:
58
+ id: journal.template.daily
59
+ type: note
60
+ ```
61
+
62
+ This is not a valid schema.
63
+
64
+ ```yml
65
+ - id: journal
66
+ title: journal
67
+ desc: ""
68
+ parent: root
69
+ children:
70
+ - daily
71
+ - id : daily
72
+ namespace: true
73
+ template:
74
+ - id: journal.template.daily
75
+ type: note
76
+ ```
77
+
78
+ ## Markdown Preview
79
+
80
+ ### Why can't I click the checkbox?
81
+
82
+ It could be that you are using the VSCode default markdown instead of Dendron's Markdown Preview.
83
+
84
+ They both have identical icons and its currently not possible to disable the builtin preview (we are looking into fixing this [here](https://github.com/dendronhq/dendron/issues/42)).
85
+
86
+ Meanwhile, you can open Dendron's markdown preview by clicking the preview button on the left of the menu bar or by using the `> Markdown Preview Enhanced: Open Preview to the Side` command
87
+
88
+ ![Markdown preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble-md.png)
89
+
90
+ ### Still initializing. Please close this window and try again after Dendron has been initialized.
91
+
92
+ When Dendron starts up, it initializes a local server which is responsible for indexing notes and fetching note metadata. Plugins like the preview depend on the server being initialized before activating. You'll know the server is initialized after you see a `Dendron is activated` notification.
93
+
94
+ ## Linux
95
+
96
+ ### Reference to Another Note on Ubuntu
97
+
98
+ If Ctrl+Shift+R (reference to another note) doesn't work on Ubuntu, do `sudo apt install xsel`.
99
+
100
+ ## Publishing
101
+
102
+ ### Can't open local preview
103
+
104
+ Dendron runs the preview on port 8080. Make sure you don't have something already running there.
105
+
106
+ - windows
107
+ ```powershell
108
+ # get ids of processes
109
+ Get-Process -Id (Get-NetTCPConnection -LocalPort 8080).OwningProcess
110
+
111
+ # if you see any result, you can stop them using the following command
112
+ Stop-process -Id {IDS_FROM_ABOVE}
113
+ ```
114
+
115
+ - linux
116
+ ```bash
117
+ # get ids
118
+ lsof -l -n -P -i tcp:8080
119
+
120
+ # kill
121
+ kill -9 {IDS}
122
+ ```
123
+
124
+ ## Etc
125
+
126
+ ### Error: spawn git ENOENT
127
+
128
+ Check if you have git installed. You can find more details [here](https://stackoverflow.com/questions/42545885/vs-code-error-spawn-git-enoent)
129
+
130
+ ### Clicking on the link creates multiple files
131
+
132
+ This is likely due to other extensions that you have installed that provide conflicting definitions for [[wiki links|dendron.topic.links#wiki-links]].
133
+
134
+ The most likely culprits are `foam` or `markdown-notes`. Uninstalling them will fix this issue.
135
+
136
+ You can see your installed
137
+
138
+ ## Send a support request
139
+
140
+ If none of the troubleshooting methods work, you can ping kevin on Discord or submit a github issue.
141
+
142
+ When doing either of these things, please include the following information:
143
+
144
+ - [[Plugin Logs|dendron.guides.cook#checking-logs]]
145
+ - [[Server Logs|dendron.guides.cook#server-logs]]
146
+ - Contents of your [[workspace settings|dendron.guides.settings]]
147
+ - Contents of [[dendron.yml|dendron.topic.commands#configure-yaml]]

Added: vault/dendron.guides.uninstall.md

Files changed (1) hide show
  1. vault/dendron.guides.uninstall.md +15 -0
vault/dendron.guides.uninstall.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: e45dc24b-b673-4144-a905-4a1c88378e28
3
+ title: Uninstall
4
+ desc: ''
5
+ updated: 1607889337490
6
+ created: 1607889245545
7
+ ---
8
+ To uninstall Dendron, uninstall the following extensions in order.
9
+
10
+ 1. Dendron Markdown Links
11
+ 2. Dendron Markdown Preview Enhanced
12
+ 3. Dendron
13
+
14
+ NOTE: The reason for this is because markdown links & markdown preview both declare a dependency on dendron extension. This dependency exists because we have an ordering requirement (dendron needs to start first and initialize the engine and the extensions connect to it) Vscode prevents you from uninstalling an extension that has active dependents, hence the sequence above.
15
+

Added: vault/dendron.guides.upgrading.md

Files changed (1) hide show
  1. vault/dendron.guides.upgrading.md +32 -0
vault/dendron.guides.upgrading.md ADDED
@@ -0,0 +1,32 @@
1
+ ---
2
+ id: 21c1288a-6fb8-42f5-90c0-9b3cc7d872ad
3
+ title: Upgrading
4
+ desc: ''
5
+ updated: 1610601370405
6
+ created: 1595010631247
7
+ stub: false
8
+ nav_order: 1.2
9
+ ---
10
+ VSCode auto updates outdated extensions periodically but if you want to trigger it manually, you can click the extensions tab and look for dendron. If there's an update available, it will be done at this point.
11
+
12
+ <a href="https://www.loom.com/share/796a10cab7204733877e7f708b6aaaca">
13
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/796a10cab7204733877e7f708b6aaaca-with-play.gif">
14
+ </a>
15
+
16
+ To check what version of dendron you're on, you can open the lookup bar and look for the version number in the title.
17
+
18
+ ## Bundled Extensions
19
+
20
+ Upgrading a recommended extension goes through the same process as upgrading dendron. It should happen automatically but you can manually trigger it by looking for the extension by name in the extension tab.
21
+
22
+ You can find the list of all bundled extensions [[here|dendron.topic.extensions]].
23
+
24
+ ## Dendron CLI and Dendron 11ty
25
+
26
+ To upgrade the CLI and 11ty, you need to manually run the following commands in your workspace:
27
+
28
+ ```
29
+ npm install --save @dendronhq/dendron-cli@latest
30
+ npm install --save @dendronhq/dendron-11ty@latest
31
+ ```
32
+

Added: vault/dendron.journal.2021.02.20.md

vault/dendron.journal.2021.02.20.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 68936a69-c876-4647-bfd3-1f95fe0cee19
3
+ title: '20'
4
+ desc: ''
5
+ updated: 1613844220407
6
+ created: 1613844220407
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.journal.2021.02.20.migration.md

vault/dendron.journal.2021.02.20.migration.md ADDED
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: acd429ee-c458-421d-a087-ea0da07b64e0
3
+ title: Migration
4
+ desc: ''
5
+ updated: 1613844174407
6
+ created: 1613844030110
7
+ ---
8
+
9
+ ## Workspace Upgrade
10
+
11
+ We recently ( 2021.02.13 ) upgraded Dendron's backend to use [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
12
+
13
+ This comes with a bunch of [[performance and size improvements|dendron.release.changelog#house-cleaning]] when developing Dendron.
14
+
15
+ If you currently have Dendron checked out, you'll need to run the following commands to migrate over to using the yarn build method.
16
+
17
+ ```sh
18
+ # get latest version
19
+ git pull
20
+
21
+ npm install -g yarn
22
+ # remove old node_modules
23
+ ./bootstrap/scripts/cleanup.sh
24
+ yarn bootstrap:bootstrap
25
+ yarn bootstrap:build
26
+
27
+ ```

Added: vault/dendron.journal.2021.02.md

Files changed (1) hide show
  1. vault/dendron.journal.2021.02.md +9 -0
vault/dendron.journal.2021.02.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 67f35b15-a617-4ba6-9e53-d111ded53456
3
+ title: '02'
4
+ desc: ''
5
+ updated: 1613844220407
6
+ created: 1613844220407
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.journal.2021.md

Files changed (1) hide show
  1. vault/dendron.journal.2021.md +9 -0
vault/dendron.journal.2021.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: ec5c992b-a6c5-42df-9da8-7c6f324095b0
3
+ title: '2021'
4
+ desc: ''
5
+ updated: 1613844220407
6
+ created: 1613844220407
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.journal.md

Files changed (1) hide show
  1. vault/dendron.journal.md +9 -0
vault/dendron.journal.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 923d1bad-74fa-4aff-bac3-9e1792db886f
3
+ title: Journal
4
+ desc: ''
5
+ updated: 1614538417713
6
+ created: 1614310670438
7
+ nav_exclude: true
8
+ ---
9
+

Added: vault/dendron.md

Files changed (1) hide show
  1. vault/dendron.md +96 -0
vault/dendron.md ADDED
@@ -0,0 +1,96 @@
1
+ ---
2
+ id: b0fe6ef7-1553-4280-bc45-a71824c2ce36
3
+ title: Dendron
4
+ desc: ''
5
+ updated: 1608840612657
6
+ created: 1595952505017
7
+ stub: false
8
+ ---
9
+ <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
10
+ <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
11
+ <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
12
+ <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
13
+
14
+ <!-- ![](https://travis-ci.com/dendronhq/dendron.svg?branch=master) -->
15
+
16
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)
17
+
18
+ The **hierarchical** note taking tool that **grows** as you do!
19
+
20
+ Dendron is an **open-source, local-first, markdown-based, note-taking tool** built on top of [VSCode](https://code.visualstudio.com/). Like most such tools, Dendron supports all the usual features you would expect like tagging, backlinks, a graph view, split panes, and so forth. But it doesn't stop there - whereas most tools (try to make it) easy to **get notes in**, they tend to make it **hard to get them back out** later, and it only **gets worse as you add more notes**. Dendron helps you **get notes back out** and **works better** the **more notes you have**.
21
+
22
+ I originally created Dendron because I'd accumulated over **20k notes** on programming and various other topics and couldn't find a tool that would let me easily add and find notes from within my knowledge base.
23
+
24
+ Traditional note-taking tools are often **too rigid** by having an in-flexible hierarchy that doesn't let you file a note in multiple places. Newer tools are **too flexible** by eschewing hierarchies altogether in favour of relying solely on backlinks.
25
+
26
+ Dendron finds the **usable center** between the two extremes by supporting backlinks of any two arbitrary notes while also maintaining a **canonical hierarchy** for every note. We do this through our **[hierarchal first approach to note taking](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html)** that relies on the combination of [[hierarchies|dendron.topic.hierarchies]], [[schemas|dendron.topic.schema]], and [[path based lookups|dendron.topic.lookup]].
27
+
28
+ With Dendron, you can **create, find, and collaborate** on information that **matters to you**.
29
+
30
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph-intro.gif)
31
+
32
+ ## Use Cases
33
+
34
+ Whether you organize your notes with [PARA](https://fortelabs.co/blog/para/) or [Zettelkasten](https://zettelkasten.de/), link notes together like [Roam](https://roamresearch.com/), or simply create notes in an ad-hoc manner, Dendron can help.
35
+
36
+ Think of it as a [second brain](https://www.buildingasecondbrain.com/) to help you **make sense** of all the information you care about.
37
+
38
+ Some popular use cases include:
39
+
40
+ - project management
41
+ - learning & academia
42
+ - personal knowledge base
43
+ - journaling of all forms
44
+ - CRM to keep track of clients, friends and enemies
45
+ - {Your Use Case Here}
46
+
47
+ ## Getting Started
48
+
49
+ ((ref:[[dendron.guides.install]]#Getting Started,1:#Install))
50
+
51
+ ## Onboarding
52
+
53
+ [Kevin](https://kevinslin.com/), the founder of Dendron, does a personal onboarding with new users. This onboarding is customized to your note taking goals and familiarity with Dendron. You can see an example onboarding below and book your own [here](https://calendly.com/thence/dendron).
54
+
55
+ <iframe width="560" height="315" src="https://www.youtube.com/embed/3io2fHRmZsE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
56
+
57
+ You can find a rough transcript of this onboarding [[here|dendron.ref.transcript]] for reference (thank you Tom Diaz for providing the transcript).
58
+
59
+ ## Join Us
60
+
61
+ <iframe src="https://ghbtns.com/github-btn.html?user=dendronhq&repo=dendron&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
62
+
63
+ To stay up to date on Dendron developments and all things knowledge management, you can follow us at [@dendronhq](https://twitter.com/dendronhq) or join us on [discord](https://discord.gg/AE3NRw9)!
64
+
65
+ ## Features
66
+
67
+ See our core [[features|dendron.features]] that help you manage your notes.
68
+
69
+ ## Getting Started
70
+
71
+ To get started, you can follow the instructions in [[quickstart|dendron.quickstart]].
72
+
73
+ ## Motivation
74
+
75
+ > "We are overwhelmed with information and we don't have the tools to properly index and filter through it. [The development of these tools, which] will give society access to and command over the inherited knowledge of the ages [should] be the first objective of our scientist" - Vannevar Bush, 1945
76
+
77
+ ## You Are Here
78
+
79
+ This project is about 1% complete, both in the sense that it is in **preview** but also that there's so much more to build. The north star of this project is to achieve _Vannevar Bush's_ original vision - to build a tool of thought that can give humanity _"**access to** and **command over** the inherited **knowledge of the ages**"_.
80
+
81
+ If you are reading this, you too, are now part of the journey. Let's take back control of our information and use it to build something better, together!
82
+
83
+ ## FAQ
84
+
85
+ See the [[FAQ|dendron.faq]] for answers for common questions.
86
+
87
+ ## Contributing
88
+
89
+ We welcome community contributions and pull requests. See [CONTRIBUTING](https://github.com/dendronhq/dendron/blob/master/docs/CONTRIBUTING.md) for information on how to set up a development environment and submit code.
90
+
91
+ ## License
92
+
93
+ Dendron is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.
94
+
95
+ See [LICENSE](https://github.com/dendronhq/dendron/blob/master/LICENSE.md) and [NOTICE](https://github.com/dendronhq/dendron/blob/master/NOTICE.md) for more information.
96
+

Added: vault/dendron.mission-statement.md

Files changed (1) hide show
  1. vault/dendron.mission-statement.md +10 -0
vault/dendron.mission-statement.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 3bf95ba0-8d6e-4bfc-b46e-c0c66cdab2ee
3
+ title: Mission Statement
4
+ desc: ''
5
+ updated: 1608575363983
6
+ created: 1602262532844
7
+ nav_exclude: true
8
+ ---
9
+ Dendron helps people create, reference, and collaborate on the information they care about.
10
+

Added: vault/dendron.principles.md

Files changed (1) hide show
  1. vault/dendron.principles.md +68 -0
vault/dendron.principles.md ADDED
@@ -0,0 +1,68 @@
1
+ ---
2
+ id: 7fcebd7d-6411-4c9d-8baf-65629dc018a1
3
+ title: Principles
4
+ desc: ''
5
+ updated: 1605042559429
6
+ created: 1600440828180
7
+ stub: false
8
+ nav_order: 1.3
9
+ ---
10
+ ## Product
11
+
12
+ ### Speed
13
+
14
+ Dendron should be the fastest way for **people** to access the information they care about.
15
+
16
+ - lookup should finish in under a second
17
+ - all parts of our toolchain should optimize for speed
18
+
19
+ ### Scale
20
+
21
+ Dendron should become easier to use as you accumulate more notes.
22
+
23
+ ### Ownership
24
+
25
+ Users should have **full control** of their data and it should be our first principle to maximize this as much as possible.
26
+
27
+ ### Interoperability
28
+
29
+ It should be possible to import/export your data from/to any other source where a user might want to use their information.
30
+
31
+ ### Easy to learn, hard to master
32
+
33
+ - see [Bushnell's Law
34
+ ](https://en.wikipedia.org/wiki/Bushnell%27s_Law#:~:text=Bushnell's%20Law%20or%20Nolan's%20Law,first%20quarter%20and%20the%20hundredth.)
35
+
36
+ ## Community
37
+
38
+ ### Open and Inclusive
39
+
40
+ Dendron is a tool for **all users** that are interested in creating, building, using, and sharing knowledge. full stop.
41
+
42
+ ### Have it in writing
43
+
44
+ We don't just share what we learn in a chat at a moment in time. We make sure that the information remains accessible longer after we are gone.
45
+
46
+ # Tradeoffs
47
+
48
+ You can't have something that is everything for everyone. There are tradeoffs we are making in Dendron.
49
+
50
+ ### Function over Form
51
+
52
+ - in Dendron, it's more important for something to be useful than it is to be beautiful
53
+ - the focus in Dendron should be about your content and the hierarchies that connect them
54
+
55
+ ### Focus on Hierarchies
56
+
57
+ - while Dendron supports backlinks and other forms of organizing notes, Dendron's foundation is tooling to help you manage hierarchies
58
+
59
+ ### Focus on Speed
60
+
61
+ - we can't predict the future but it's likely that no one will ever say that they wish their note taking experience to be slower
62
+ - when thinking about features and tool chain, bias for speed
63
+
64
+ ### Retrieval over Insertion
65
+
66
+ - all note taking tools focus on putting notes in but they struggle with helping users get notes back out, especially as users accumulate a lot of notes
67
+ - Dendron takes the long view that you will read your notes far more than you write and optimize for getting notes back out
68
+

Added: vault/dendron.pro.dendron-11ty.install.md

vault/dendron.pro.dendron-11ty.install.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ id: 9ad8ae37-9f32-4043-b3f9-b36799a62bf0
3
+ title: Install
4
+ desc: ''
5
+ updated: 1613096860430
6
+ created: 1613096860430
7
+ ---
8
+

Added: vault/dendron.pro.dendron-11ty.internal.md

vault/dendron.pro.dendron-11ty.internal.md ADDED
@@ -0,0 +1,36 @@
1
+ ---
2
+ id: aa6009e6-db3d-44d8-bc60-723f03c048f7
3
+ title: Internal
4
+ desc: ''
5
+ updated: 1613752914594
6
+ created: 1612974783445
7
+ ---
8
+
9
+ ## Videos
10
+ - [11ty and markdown parsing: I](https://youtu.be/3qWjBh3A55s)
11
+ - [11ty and markdown parsing: II](https://youtu.be/5VJw102iosE)
12
+ - [11ty and markdown parsing: III](https://youtu.be/E5erv3GawAc)
13
+
14
+ ## Generate notes
15
+
16
+ - _includes/includes/note.liquid
17
+ - notesOnly
18
+
19
+ - _data/notesOnly.js
20
+ ```ts
21
+ return SiteUtils.filterByConfig({ engine, config })
22
+ ```
23
+
24
+ ## Rendering Notes
25
+
26
+ - libs/shortcodes.js
27
+
28
+ ```ts
29
+ toMarkdown2 {
30
+ procFull {
31
+ const engine = await getEngine();
32
+ ...
33
+ }
34
+ }
35
+
36
+ ```

Added: vault/dendron.pro.dendron-11ty.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-11ty.md +23 -0
vault/dendron.pro.dendron-11ty.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: 53dd4b9b-d3a7-4398-9511-b7a281039f9d
3
+ title: Dendron-11ty
4
+ desc: ''
5
+ updated: 1611515672976
6
+ created: 1608181727204
7
+ ---
8
+
9
+ ## Repo
10
+ - https://github.com/dendronhq/dendron-11ty
11
+
12
+
13
+ ## Cook
14
+
15
+ - check all notes that are published
16
+ ```bash
17
+ cat /tmp/notes.log | jq '[. | to_entries[] | .value ] | .[].fname'
18
+ ```
19
+
20
+ - check all published notes using search-data
21
+ ```bash
22
+ cat assets/js/search-data.json | jq '.[].hpath'
23
+ ```

Added: vault/dendron.pro.dendron-11ty.qa.md

vault/dendron.pro.dendron-11ty.qa.md ADDED
@@ -0,0 +1,24 @@
1
+ ---
2
+ id: feb740f8-0d7b-4bc6-83bb-85886fe779f6
3
+ title: Qa
4
+ desc: ''
5
+ updated: 1612908712863
6
+ created: 1612903299090
7
+ ---
8
+
9
+ ## Test with a single file
10
+
11
+
12
+ - update the `dendron.yml` file
13
+ ```yml
14
+ ...
15
+ site:
16
+ siteHierarchies:
17
+ - foobar
18
+ ```
19
+
20
+ - start the dendron workspace
21
+ - create `foobar.md` with the frontmatter
22
+ - add whatever syntax you want to test
23
+ - run the CLI
24
+ ![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview,1:#*]]

Added: vault/dendron.pro.dendron-11ty.quickstart.md

vault/dendron.pro.dendron-11ty.quickstart.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: 132698b3-cfe0-457f-b7d6-7ddba5cfe096
3
+ title: Quickstart
4
+ desc: getting started with a project
5
+ updated: 1611515835789
6
+ created: 1611515667674
7
+ ---
8
+
9
+
10
+ ### Install dendron-11ty
11
+
12
+ ```bash
13
+ yarn init
14
+ npm install @dendronhq/dendron-cli@latest
15
+ npm install @dendronhq/dendron-11ty@latest
16
+ ```
17
+
18
+ ### Start the server in preview
19
+
20
+ - cd to your [[workspace root|dendron.concepts#workspace]]
21
+ ```bash
22
+ cd {workspace root}
23
+ npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve
24
+ ```
25
+
26
+ ### Build notes for production
27
+
28
+ ```bash
29
+ npx dendron-cli buildSiteV2 --wsRoot . --stage prod
30
+ ```

Added: vault/dendron.pro.dendron-11ty.setup.md

vault/dendron.pro.dendron-11ty.setup.md ADDED
@@ -0,0 +1,57 @@
1
+ ---
2
+ id: 6f3bc07c-5232-4148-a42f-bac9c2fe12f6
3
+ title: Setup
4
+ desc: ''
5
+ updated: 1612903363450
6
+ created: 1611515613711
7
+ ---
8
+
9
+ ## Getting started
10
+
11
+ ### 1. Requirements
12
+
13
+ ![[dendron.dev.setup#1-requirements,1:#*]]
14
+
15
+
16
+ ### 2. Clone and Install
17
+
18
+ ```bash
19
+ git clone https://github.com/dendronhq/dendron-11ty
20
+ cd dendron-11ty
21
+ npm install
22
+ ```
23
+
24
+ ### 3. Run 11ty
25
+
26
+ ![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview]]
27
+
28
+ ## Running with dendron monorepo
29
+
30
+ Dendron depends on a bunch of packages from the dendron monorepo. If you already have it installed and are working on monorepo components, you can link those components with 11ty to have live updates.
31
+
32
+ ### 1. Setup Monorepo
33
+ - see instructions [[here|dendron.dev.setup]]
34
+
35
+ ### 2. Create links to the monorepo packages
36
+
37
+ Run `yarn link` inside the following packages
38
+ * @dendronhq/engine-server
39
+ * @dendronhq/common-server
40
+ * @dendronhq/common-all
41
+
42
+
43
+ ### 3. Link monorepo to 11ty
44
+
45
+ Inside dendron-11ty, execute `./scripts/link.sh` file
46
+
47
+ - NOTE: don't forget to watch the monorepo to compile changes
48
+
49
+ ![[dendron.dev.setup#watch-monorepo,1:#*]]
50
+
51
+ ### 4. Run Dendron Cli
52
+
53
+ You can run this CLI on any valid workspace. There's a test workspace in `dendron-11ty` that is good to test against
54
+ ```sh
55
+ cd dendron-11ty/fixtures/test-workspace
56
+ ```
57
+ ![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview,1:#*]]

Added: vault/dendron.pro.dendron-api-server.internal.md

vault/dendron.pro.dendron-api-server.internal.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: 767852dd-8e11-4e17-a68d-ae3e73811b1c
3
+ title: Internal
4
+ desc: ''
5
+ updated: 1610144264886
6
+ created: 1610144200281
7
+ ---
8
+
9
+ # Launch
10
+ - file: src/index.ts
11
+
12
+ ```ts
13
+ launch {
14
+ appModule = require("./Server")
15
+ ...
16
+ }
17
+
18
+ ```
19
+

Added: vault/dendron.pro.dendron-api-server.md

vault/dendron.pro.dendron-api-server.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: 554d3c62-29da-4c86-9d16-f910e36ad7b1
3
+ title: Ops
4
+ desc: ''
5
+ updated: 1610144187255
6
+ created: 1606628243560
7
+ ---
8
+
9
+ ### Initialize a workspace
10
+
11
+ - NOTE: specific to kevin's vault, modify for your own
12
+
13
+ ```bash
14
+ curl --location --request POST 'http://localhost:3005/api/workspace/initialize' \
15
+ --header 'Content-Type: application/json' \
16
+ --data-raw '{
17
+ "uri": "/Users/kevinlin/Dendron",
18
+ "config": {
19
+ "vaults": ["/Users/kevinlin/Dendron/vault"]
20
+ }
21
+ }'
22
+ ```
23
+

Added: vault/dendron.pro.dendron-cli.dev.md

vault/dendron.pro.dendron-cli.dev.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ id: 832a6e4d-4ed9-414f-baa8-d2f20432c934
3
+ title: Dev
4
+ desc: ''
5
+ updated: 1609350699104
6
+ created: 1609350672493
7
+ ---
8
+
9
+
10
+ ## Issues
11
+
12
+ ### Unexpected Token
13
+ name: 'EleventyConfigError',
14
+ originalError:
15
+ /codebuild/output/src896656404/src/staging/node_modules/@dendronhq/dendron-11ty/libs/utils.js:68
16
+ static getUrl = (note) => {
17
+ SyntaxError: Unexpected token =

Added: vault/dendron.pro.dendron-cli.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-cli.md +9 -0
vault/dendron.pro.dendron-cli.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: c968377f-56e5-470f-801e-c730a1c071d4
3
+ title: Dendron CLI
4
+ desc: ''
5
+ updated: 1614924056383
6
+ created: 1614837297111
7
+ ---
8
+
9
+ The Dendron CLI exposes Dendron's functionality via the command line.

Added: vault/dendron.pro.dendron-cli.qa.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-cli.qa.md +12 -0
vault/dendron.pro.dendron-cli.qa.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: a49370b7-fe61-4174-bf85-f67d15fa35ff
3
+ title: Qa
4
+ desc: ''
5
+ updated: 1614837591776
6
+ created: 1614837254472
7
+ ---
8
+
9
+ ## Debug
10
+ To debug specific dendron-cli commands, run a CLI [[tasks|dendron.dev.ref.vscode#tasks]] from `dendron-cli/.vscode/tasks.json`
11
+
12
+ See the `build-site` inside `tasks.json` for an example.

Added: vault/dendron.pro.dendron-engine.cook.md

vault/dendron.pro.dendron-engine.cook.md ADDED
@@ -0,0 +1,105 @@
1
+ ---
2
+ id: 1bce1c33-c14b-4e5e-b493-45683c8cf54f
3
+ title: Cook
4
+ desc: ''
5
+ updated: 1615092736145
6
+ created: 1610469139531
7
+ ---
8
+
9
+ ### Adding a new unified plugin
10
+ <!-- - [pr example](https://github.com/dendronhq/dendron/pull/260) -->
11
+ <!-- ea648849f94528d8000a31fd8b89ca8c89de2598 -->
12
+
13
+ Resources:
14
+ - [video of pairing session](https://youtu.be/mHkx17akuCg)
15
+ - [commit from pairing session](https://github.com/dendronhq/dendron/commit/ea648849f94528d8000a31fd8b89ca8c89de2598)
16
+
17
+ Context:
18
+ - Dendron uses [remark](https://github.com/remarkjs/remark) and [rehype](https://github.com/rehypejs/rehype) to handle markdown and html transformations
19
+ - Dendron uses a series of [processors](https://github.com/unifiedjs/unified#processor) to group unified plugins
20
+ - Dendron currently compiles markdown into output formats listed [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/markdown/types.ts#L28:L28)
21
+
22
+ Steps:
23
+
24
+ 1. add the plugin to engine-server
25
+ - NOTE: we are still using remark12 so make sure to install the remark12 compatible version of the plugin
26
+ - instructions to add new packages [[here|dendron.dev.cook#install-a-new-package]]
27
+ 1. update `src/markdown/utils.ts` in engine-server
28
+ - import plugin and add it to the appropriate processor (most likely `procFull`)
29
+ 1. write a test for the plugin. plugin tests are located in `engine-test-utils/src/__tests__/engine-server/markdown/`
30
+ - example [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-test-utils/src/__tests__/engine-server/markdown/container.spec.ts)
31
+ - `createProcTests` is a special function that sets up a Dendron workspace and can help you run a unified processor for multiple output formats
32
+ - your test should cover every output format that your plugin affects
33
+ - best way to understand is by example, see the other tests in the same folder for additional examples of how to use this function
34
+ 1. write the plugin implementation
35
+ 1. make sure your tests pass
36
+ - its helpful to use the `matchSnapshot` functionality that jest provides
37
+ if you use the `checkVFile` helper function, this happens automatically
38
+ - you can view snapshots in `__snapshots__/` folder which is relative to the test
39
+ 1. add a flag in `DendronConfig` to toggle the plugin
40
+ - by default, new plugins are opt-in
41
+ - if the plugin only affects HTML output, you can put the option in `DendronSiteConfig`
42
+ 1. go back into `src/markdown/utils.ts` and use the newly created config value
43
+ - pass it in as an optional param in `proc*`
44
+ - conditionally add plugin in config is present
45
+ 1. add a test that makes sure the plugin doesn't take into affect if the config is not enabled
46
+
47
+ Notes on testing:
48
+ - when testing `transformers`, `process` will run over the node that is passed in to the processor
49
+ - when testing `parsers` and `compilers`, `process` will run over the text that you pass into it
50
+
51
+ ### Connecting to the engine
52
+
53
+ ```ts
54
+ import { DEngineClientV2, EngineConnector } from "@dendronhq/engine-server";
55
+
56
+ let dendronEngine: DEngineClientV2;
57
+ const connector = EngineConnector.instance();
58
+ if (_.isUndefined(connector._engine)) {
59
+ return vscode.window.showInformationMessage(
60
+ "Still initializing. Please close this window and try again after Dendron has been initialized",
61
+ );
62
+ }
63
+ dendronEngine = connector.engine;
64
+ if (!engine) {
65
+ engine = this.initMarkdownEngine({ sourceUri, dendronEngine });
66
+ }
67
+ ```
68
+
69
+ ### Querying notes by ID
70
+
71
+ - [type definitions](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/typesv2.ts#L362:L362)
72
+ ```ts
73
+
74
+ engine.queryNote
75
+
76
+ ```
77
+
78
+ ### Query notes by file name
79
+ - note: make sure that the engine is initialized
80
+
81
+ - with vault
82
+ ```ts
83
+ import {NoteUtilsV2} from "@dendronhq/engine-server";
84
+
85
+ const maybeNode = NoteUtilsV2.getNoteByFnameV4({
86
+ fname: dirname,
87
+ notes: nodes,
88
+ vault,
89
+ });
90
+ ```
91
+
92
+ - without vault (gets all notes with this name)
93
+
94
+ ```ts
95
+ import {NoteUtilsV2} from "@dendronhq/engine-server";
96
+
97
+ const maybeNode = NoteUtilsV2.getNotesByFname({({
98
+ fname: dirname,
99
+ notes: nodes,
100
+ });
101
+ ```
102
+
103
+ ### Note Response
104
+
105
+ ![[dendron.pro.dendron-engine.ref.note-response]]

Added: vault/dendron.pro.dendron-engine.internal.markdown.md

vault/dendron.pro.dendron-engine.internal.markdown.md ADDED
@@ -0,0 +1,68 @@
1
+ ---
2
+ id: 8289cf77-51fa-4644-96c6-b5b2c2ef62fc
3
+ title: Markdown
4
+ desc: ''
5
+ updated: 1614024416739
6
+ created: 1613752938733
7
+ ---
8
+
9
+
10
+ ## Note Refs - Markdown
11
+
12
+
13
+ - file: src/markdown/remark/noteRefsV2.ts
14
+ ```ts
15
+ compiler {
16
+ if dest != MD_DENDRON:
17
+ convertNoteRef
18
+ }
19
+
20
+ convertNoteRef {
21
+
22
+ refLvl := proc
23
+ return if refLvl > MAX_REF_LVL
24
+
25
+ noteRefs :=
26
+
27
+ noteRefs.map {
28
+ convertNoteRefHelper
29
+ }
30
+
31
+ }
32
+
33
+ convertNoteRefHelper(body) {
34
+ bodyAST = proc.parse body
35
+ let out = proc
36
+ .processSync(noteRefProc.stringify(bodyAST))
37
+ return out
38
+ }
39
+ ```
40
+
41
+ ```ts
42
+
43
+ ```
44
+
45
+ ## Note Refs - HTML
46
+
47
+ - file: src/markdown/remark/dendronPub.ts
48
+ ```ts
49
+ data = convertNoteRefASTV2
50
+ parent.children = data;
51
+ ```
52
+
53
+ ```ts
54
+ convertNoteRefASTV2 {
55
+ noteRefs :=
56
+ noteRefs.map {
57
+ convertNoteRefHelperAST
58
+ }
59
+ }
60
+
61
+ convertNoteRefHelperAST(noteRefProc) {
62
+ /**
63
+ * RefLink Node
64
+ */
65
+ bodyAST = noteRefProc.parse(body)
66
+
67
+ }
68
+ ```

Added: vault/dendron.pro.dendron-engine.internal.md

vault/dendron.pro.dendron-engine.internal.md ADDED
@@ -0,0 +1,81 @@
1
+ ---
2
+ id: 26be950a-eaf3-4684-bddd-64be52273b73
3
+ title: Internal
4
+ desc: ''
5
+ updated: 1614924289100
6
+ created: 1608527496774
7
+ ---
8
+
9
+ ## Initializing a new workspace
10
+ - engine-server/src/workspace.ts
11
+
12
+ ```ts
13
+ WorkspaceService.createWorkspace
14
+ ```
15
+
16
+ ## Initializing dendron.yml
17
+
18
+ ## Renaming a Note
19
+
20
+ ### Flow
21
+
22
+ - engine-server/src/drivers/file/storev2.ts
23
+
24
+ ```ts
25
+ renameNote opts {
26
+ oldNote, oldLoc, newLoc := opts
27
+ notesToChange = getNotesWithLinkTo(oldNote)
28
+ notesToChange.forEach { n =>
29
+ replaceLinks(n, from: oldLoc, to: newLoc)
30
+ n.links = findLinks(n)
31
+ }
32
+ newNote = {oldNote, newLoc}
33
+ @deleteNote( oldNode, metaOnly)
34
+ }
35
+ ```
36
+
37
+ - src/topics/markdown/utilsv2.ts
38
+
39
+ ```ts
40
+ replaceLinks opts {
41
+ remark = getRemark(dendronLinksOpts: {replaceLink: { from, to }} )
42
+ return remark.process(opts.content).toString()
43
+ }
44
+ ```
45
+
46
+ - src/drivers/file/storev2.ts
47
+
48
+ ```ts
49
+ deleteNote(note) {
50
+ ...
51
+ if !note.children {
52
+ ...
53
+ } else {
54
+ }
55
+
56
+ }
57
+
58
+ ```
59
+
60
+ - See [[Remark|dendron.dev.design.remark]]
61
+
62
+ ## MISC
63
+
64
+ ### Does Dendron use parent/children metadata inside notes during initialization?
65
+
66
+ - src/filesv2.ts: `string2Note`
67
+
68
+ # WorkspaceService: Add Vault
69
+
70
+ - src/workspace.ts
71
+
72
+ ```ts
73
+ createVault(vault, noAddToConfig):
74
+ ensureDir(vault)
75
+ createNoteRoot if not_exist
76
+ createSchemaRoot if not_exist
77
+
78
+ if !noAddToConfig:
79
+ config.add vault
80
+ ```
81
+

Added: vault/dendron.pro.dendron-engine.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-engine.md +62 -0
vault/dendron.pro.dendron-engine.md ADDED
@@ -0,0 +1,62 @@
1
+ ---
2
+ id: 5a7103be-eb92-4380-8207-598e9f10724c
3
+ title: Dendron Engine
4
+ desc: ''
5
+ updated: 1609699498153
6
+ created: 1605108924902
7
+ ---
8
+ The engine provides the core of dendron's capabilities.
9
+
10
+ # Components
11
+
12
+ ## Fuse.js
13
+
14
+ - https://fusejs.io
15
+ - powers dendron fuzzy search
16
+
17
+ ### Cook
18
+
19
+ #### Tune Search Results
20
+
21
+ 1. checkout fuse.js from <https://github.com/krisk/fuse>
22
+ 2. install dependencies
23
+ ```bash
24
+ npm install
25
+ ```
26
+ 3. build the docs
27
+ ```bash
28
+ npm run docs:dev
29
+ ```
30
+ 4. modify `docs/.vuepress/components/Demo/Demo.vue`
31
+
32
+ - example of setting custom parameters
33
+
34
+ ```js
35
+ let codify = (pattern) => {
36
+ return `const options = {
37
+ shouldSort: true,
38
+ threshold: 0.6,
39
+ location: 0,
40
+ distance: 50,
41
+ maxPatternLength: 32,
42
+ minMatchCharLength: 2,
43
+ useExtendedSearch: true,
44
+ includeScore: true,
45
+ keys: [
46
+ "title",
47
+ ]
48
+ };
49
+
50
+ const fuse = new Fuse(list, options);
51
+
52
+ // Change the pattern
53
+ const pattern = "${pattern}"
54
+
55
+ return fuse.search(pattern)`
56
+ }
57
+ ```
58
+
59
+ ## Related
60
+
61
+ - [[Server Migration|dendron.roadmap.project.n.2020.server-migration]]
62
+

Added: vault/dendron.pro.dendron-engine.qa.md

vault/dendron.pro.dendron-engine.qa.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: 60fbcc05-df2a-44a2-aa0e-cdd62c2557b6
3
+ title: Qa
4
+ desc: ''
5
+ updated: 1614812452030
6
+ created: 1614812225185
7
+ ---
8
+
9
+ ## Unified Tests
10
+
11
+ These tests cover everything related to `unified` plugins. This refers to anything in packages/engine-server/src/markdown/utils.ts
12
+
13
+ - plugin tests are located in `packages/engine-test-utils/src/__tests__/engine-server/markdown/`
14
+ - [terminology](https://www.kevinslin.com/notes/09b6c659-3fe3-4a7d-98f9-47e7167cca5b.html) to understand
15
+ - when testing `transformers`, `process` will run over the node that is passed in to the processor
16
+ - when testing `parsers` and `compilers`, `process` will run over the text that you pass into it
17
+
18
+ ### Transformer Test

Added: vault/dendron.pro.dendron-engine.ref.md

vault/dendron.pro.dendron-engine.ref.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 6ef73a3c-d3c0-4e21-9d77-76ad353a3cf9
3
+ title: Ref
4
+ desc: ''
5
+ updated: 1611162452714
6
+ created: 1611162452714
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.pro.dendron-engine.ref.note-response.md

vault/dendron.pro.dendron-engine.ref.note-response.md ADDED
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: 0db94b86-d5c2-4e70-8f61-1a686fa8cc1d
3
+ title: Note Response
4
+ desc: ''
5
+ updated: 1614294605017
6
+ created: 1611160590954
7
+ ---
8
+
9
+ - NOTE: response has been truncated in some areas with `...` for sake of clarity
10
+ ```json
11
+ {
12
+ "id": "e3002a40-6571-4120-8311-c4a9af948e07",
13
+ "title": "Foo",
14
+ "vault": {
15
+ "fsPath": "/Users/kevinlin/Dropbox/Apps/Noah/vaults/people-vault"
16
+ },
17
+ "type": "note",
18
+ "desc": "",
19
+ "links": [
20
+ {
21
+ "type": "wiki",
22
+ "from": {
23
+ "fname": "foo",
24
+ "id": "e3002a40-6571-4120-8311-c4a9af948e07"
25
+ },
26
+ "original": "people.james",
27
+ "value": "people.james",
28
+ "alias": "people.james",
29
+ "pos": {
30
+ "start": 128,
31
+ "end": 155
32
+ },
33
+ "to": {
34
+ "fname": "people.james"
35
+ }
36
+ },
37
+ ...
38
+ ],
39
+ "fname": "foo",
40
+ "updated": 1610409926314,
41
+ "created": 1610381470060,
42
+ "parent": "af9c2275-84dd-4d86-b0a3-af9d8cd2fb08",
43
+ "children": [],
44
+ "body": "...",
45
+ "data": {},
46
+ "custom": {
47
+ "published": true
48
+ }
49
+ }
50
+ ```
51
+
52
+ ## Links
53
+ - [type definition](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/typesv2.ts#L166:L166)

Added: vault/dendron.pro.dendron-engine.ref.unified.md

vault/dendron.pro.dendron-engine.ref.unified.md ADDED
@@ -0,0 +1,169 @@
1
+ ---
2
+ id: a97e7686-41ae-41e3-8db0-004daea947f9
3
+ title: Unified
4
+ desc: ''
5
+ updated: 1614542120377
6
+ created: 1614541791058
7
+ ---
8
+
9
+ exports[`proto wiilinks as list 1`] = `
10
+ Object {
11
+ "children": Array [
12
+ Object {
13
+ "children": Array [
14
+ Object {
15
+ "checked": null,
16
+ "children": Array [
17
+ Object {
18
+ "children": Array [
19
+ Object {
20
+ "data": Object {
21
+ "alias": "one",
22
+ "anchorHeader": undefined,
23
+ "vaultName": undefined,
24
+ },
25
+ "position": Position {
26
+ "end": Object {
27
+ "column": 10,
28
+ "line": 1,
29
+ "offset": 9,
30
+ },
31
+ "indent": Array [],
32
+ "start": Object {
33
+ "column": 3,
34
+ "line": 1,
35
+ "offset": 2,
36
+ },
37
+ },
38
+ "type": "wikiLink",
39
+ "value": "one",
40
+ },
41
+ ],
42
+ "position": Position {
43
+ "end": Object {
44
+ "column": 10,
45
+ "line": 1,
46
+ "offset": 9,
47
+ },
48
+ "indent": Array [],
49
+ "start": Object {
50
+ "column": 3,
51
+ "line": 1,
52
+ "offset": 2,
53
+ },
54
+ },
55
+ "type": "paragraph",
56
+ },
57
+ ],
58
+ "position": Position {
59
+ "end": Object {
60
+ "column": 10,
61
+ "line": 1,
62
+ "offset": 9,
63
+ },
64
+ "indent": Array [],
65
+ "start": Object {
66
+ "column": 1,
67
+ "line": 1,
68
+ "offset": 0,
69
+ },
70
+ },
71
+ "spread": false,
72
+ "type": "listItem",
73
+ },
74
+ Object {
75
+ "checked": null,
76
+ "children": Array [
77
+ Object {
78
+ "children": Array [
79
+ Object {
80
+ "data": Object {
81
+ "alias": "two",
82
+ "anchorHeader": undefined,
83
+ "vaultName": undefined,
84
+ },
85
+ "position": Position {
86
+ "end": Object {
87
+ "column": 10,
88
+ "line": 2,
89
+ "offset": 19,
90
+ },
91
+ "indent": Array [],
92
+ "start": Object {
93
+ "column": 3,
94
+ "line": 2,
95
+ "offset": 12,
96
+ },
97
+ },
98
+ "type": "wikiLink",
99
+ "value": "two",
100
+ },
101
+ ],
102
+ "position": Position {
103
+ "end": Object {
104
+ "column": 10,
105
+ "line": 2,
106
+ "offset": 19,
107
+ },
108
+ "indent": Array [],
109
+ "start": Object {
110
+ "column": 3,
111
+ "line": 2,
112
+ "offset": 12,
113
+ },
114
+ },
115
+ "type": "paragraph",
116
+ },
117
+ ],
118
+ "position": Position {
119
+ "end": Object {
120
+ "column": 10,
121
+ "line": 2,
122
+ "offset": 19,
123
+ },
124
+ "indent": Array [],
125
+ "start": Object {
126
+ "column": 1,
127
+ "line": 2,
128
+ "offset": 10,
129
+ },
130
+ },
131
+ "spread": false,
132
+ "type": "listItem",
133
+ },
134
+ ],
135
+ "ordered": false,
136
+ "position": Position {
137
+ "end": Object {
138
+ "column": 10,
139
+ "line": 2,
140
+ "offset": 19,
141
+ },
142
+ "indent": Array [
143
+ 1,
144
+ ],
145
+ "start": Object {
146
+ "column": 1,
147
+ "line": 1,
148
+ "offset": 0,
149
+ },
150
+ },
151
+ "spread": false,
152
+ "start": null,
153
+ "type": "list",
154
+ },
155
+ ],
156
+ "position": Object {
157
+ "end": Object {
158
+ "column": 10,
159
+ "line": 2,
160
+ "offset": 19,
161
+ },
162
+ "start": Object {
163
+ "column": 1,
164
+ "line": 1,
165
+ "offset": 0,
166
+ },
167
+ },
168
+ "type": "root",
169
+ };

Added: vault/dendron.pro.dendron-jekyll.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-jekyll.md +37 -0
vault/dendron.pro.dendron-jekyll.md ADDED
@@ -0,0 +1,37 @@
1
+ ---
2
+ id: 4c0ef322-3006-405c-9a66-3134dd9649a5
3
+ title: Dendron Jekyll
4
+ desc: ''
5
+ updated: 1596683603070
6
+ created: 1596683603070
7
+ stub: false
8
+ ---
9
+ This is the Jekyll theme used by Dendron. It is a fork of [just-the-docs](https://pmarsceill.github.io/just-the-docs/) theme with custom changes to allow for deep hierarchies, lookups and unique ids. It also borrows many elements from the [Minimal Mistakes theme](https://mmistakes.github.io/minimal-mistakes/).
10
+
11
+ - [github repo](https://github.com/dendronhq/dendron-jekyll)
12
+
13
+ # Blogging
14
+
15
+ dendron-jekyll has custom layouts well suited for blogging. You can see an example of it in action [here](https://www.kevinslin.com/notes/b9bc4aa1-4369-446d-91a9-13d4f2a4b8e5.html).
16
+
17
+ Blog Optimized Features:
18
+
19
+ - ability to show all notes within a hierarchy organized by timestamp
20
+ - wider layout for the text
21
+ - helper utilities from [minimal mistakes](https://mmistakes.github.io/minimal-mistakes/docs/helpers/)
22
+ - NOTE: currently, only `figure` is supported
23
+
24
+ ## Getting Started
25
+
26
+ - 🚧 Instructions are currently being written and will be up soon
27
+
28
+ # Remote and Gem Based Themes
29
+
30
+ Dendron Jekyll works as both a github remote theme and as a gem based theme. [dendron.so](https://dendron.so) is built from dendron-jekyll as a remote-theme from this [repo](https://github.com/dendronhq/dendron-template) and deployed using [github pages](https://pages.github.com/).
31
+
32
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll-dendron-so.gif)
33
+
34
+ [kevinslin.com](https://www.kevinslin.com/) is built as a gem based theme from a private github repo and deployed using [AWS Amplify](https://aws.amazon.com/amplify/).
35
+
36
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll-kevinslin.gif)
37
+

Added: vault/dendron.pro.dendron-jekyll.topic.frontmatter.md

vault/dendron.pro.dendron-jekyll.topic.frontmatter.md ADDED
@@ -0,0 +1,47 @@
1
+ ---
2
+ id: f9c646b1-34ab-4b18-8ec1-cabb8b2c7066
3
+ title: Frontmatter
4
+ desc: ''
5
+ updated: 1600573427628
6
+ created: 1600573427628
7
+ stub: false
8
+ ---
9
+ Dendron notes have [[frontmatter|dendron.topic.frontmatter]]. Dendron Jekyll uses this frontmatter to configure various aspects about the appearance and publication status of a particular page.
10
+
11
+ ## Appearance
12
+
13
+ ### title: string
14
+
15
+ Title of the content. Control's how the title shows up in the nav bar
16
+
17
+ ### sources: source\[]
18
+
19
+ Automatically create attributions for a page
20
+
21
+ - eg: [AWS Page](https://aws.dendron.so/notes/dynamodb.html#)
22
+
23
+ ```yml
24
+ ...
25
+ sources:
26
+ - name: og-aws
27
+ url: 'https://github.com/open-guides/og-aws'
28
+ license: Creative Commons Attribution-ShareAlike 4.0 International License
29
+ - name: Jerry Hargrove
30
+ url: 'https://www.awsgeek.com/'
31
+ license: Creative Commons Attribution-ShareAlike 4.0 International License
32
+ ```
33
+
34
+ ![](/assets/images/2020-09-19-20-53-12.png)
35
+
36
+ ## Publication
37
+
38
+ ### published: boolean
39
+
40
+ Specifies if the page should be published or not.
41
+
42
+ By default, everything under `siteHierarchies` is published unless `publishByDefault` is turned `off`. In that case, you must set `published: true` in order to publish a page under the given hierarchy.
43
+
44
+ You can also set this to `false` to selectively withhold specific pages from publication.
45
+
46
+ ((ref:[[dendron.topic.publishing.configuration]]#config:#*))
47
+

Added: vault/dendron.pro.dendron-jekyll.topic.math.md

vault/dendron.pro.dendron-jekyll.topic.math.md ADDED
@@ -0,0 +1,38 @@
1
+ ---
2
+ id: 84e01690-4ea0-4b71-8cc4-c2d38e09dcf4
3
+ title: Math
4
+ desc: ''
5
+ updated: 1603589517663
6
+ created: 1602087509879
7
+ stub: false
8
+ ---
9
+ You can enable math using the following options in the `_config.yml`. By default, this will be located in `{workspace}/docs/_config.yml`
10
+
11
+ ```yml
12
+ enable_mathjax: true;
13
+ kramdown:
14
+ math_engine: mathjax
15
+ ```
16
+
17
+ - NOTE: If you are using the local preview, be sure to reload your server to have the changes take place.
18
+
19
+ You can now add math using the standard [mathjax](https://www.mathjax.org/) notation.
20
+
21
+ - NOTE: only `block level` mathjax is supported at the current time
22
+
23
+ ### Example
24
+
25
+ The following
26
+
27
+ ```
28
+ $$
29
+ f(x) = sin(x)
30
+ $$
31
+ ```
32
+
33
+ will render as
34
+
35
+ $$
36
+ f(x) = sin(x)
37
+ $$
38
+

Added: vault/dendron.pro.dendron-jekyll.topic.md

vault/dendron.pro.dendron-jekyll.topic.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 442df590-669a-45b4-8e0c-ba9bd699413f
3
+ title: Topics
4
+ desc: ''
5
+ updated: 1600573417342
6
+ created: 1600573417342
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.pro.dendron-next-server.md

vault/dendron.pro.dendron-next-server.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: 7cdd9a74-8b8f-4564-906b-c963bed34273
3
+ title: Dendron Next Server
4
+ desc: ''
5
+ updated: 1614924050218
6
+ created: 1604511741960
7
+ ---
8
+ ## Quickstart
9
+
10
+ 1. follow instructions [[here|dendron.dev.setup]] to clone the repository and install dependencies
11
+ 2. navigate to server package
12
+ ```bash
13
+ cd {repo-root}/packages/dendron-next-server
14
+ ```
15
+ 3. start server
16
+ ```bash
17
+ yarn dev
18
+ ```
19
+ 4. Open `dendron-next-server.code-workspace` to start editing the code
20
+
21
+ ## Working with the Dendron Engine
22
+
23
+ If your working with the Dendron Engine (eg. fetching notes, config or schemas), you'll need to start an instance of the engine.
24
+
25
+ First, install the Dendron CLI
26
+ ((ref:[[dendron.topic.cli]]#installation,1:#*))
27
+
28
+ Next, use the `launchEngineServer` command to start the server to an existing workspace
29
+
30
+ ```
31
+ LOG_DST=/tmp/server.txt LOG_LEVEL=debug dendron-cli launchEngineServer --port 3005 --wsRoot ~/Dendron/
32
+ ```
33
+
34
+ Create an `.env.local` file under `dendron-next-server` and add the following
35
+
36
+ ```
37
+ ENGINE_ENDPOINT_PORT=3005
38
+ ```
39
+
40
+ Run `yarn dev` to start the next server
41
+

Added: vault/dendron.pro.dendron-plugin.deploy.md

vault/dendron.pro.dendron-plugin.deploy.md ADDED
@@ -0,0 +1,143 @@
1
+ ---
2
+ id: 2976e5df-c8b4-4176-9d3f-fe4220dfa9b6
3
+ title: Deploy
4
+ desc: ''
5
+ updated: 1615242299836
6
+ created: 1613863275374
7
+ ---
8
+
9
+
10
+
11
+ ## pre-req
12
+ ```sh
13
+ npm install -g verdaccio
14
+ npm install -g yarn
15
+ npm install -g vsce
16
+ sudo apt-get install jq -y
17
+
18
+ git clone git@github.com:dendronhq/dendron.git dendron
19
+ git clone git@github.com:dendronhq/dendron.git dendron-build
20
+ ```
21
+
22
+ - run verdaccio
23
+ ```
24
+ verdaccio
25
+ ```
26
+
27
+
28
+ ## build and source
29
+
30
+ ```sh
31
+ yarn
32
+ yarn bootstrap:build
33
+ . bootstrap/scripts/helpers.sh
34
+ ```
35
+
36
+ ## test local
37
+
38
+ - publish from local
39
+ ```sh
40
+ setRegLocal
41
+ verdaccio
42
+
43
+ gbD integ-publish
44
+ gco -b integ-publish
45
+
46
+ version=minor
47
+ lerna version $version --no-git-tag-version
48
+
49
+ git add .
50
+ git commit -m "integ: publish $version"
51
+ git push --set-upstream origin integ-publish --force
52
+
53
+ lerna publish from-package
54
+
55
+ # if you already built
56
+ lerna publish from-package --ignore-scripts
57
+ node bootstrap/scripts/genMeta.js
58
+ ```
59
+
60
+ - pull in new changes
61
+ ```sh
62
+ WORKSPACE_BUILD=/mnt/one/dendron-build
63
+ WORKSPACE_BUILD=/Users/kevinlin/projects/dendronv2/dendron/build/dendron/packages/plugin-core
64
+ cd $WORKSPACE_BUILD
65
+
66
+ git reset --hard
67
+ git clean -f
68
+ gco master
69
+ gbD integ-publish
70
+ git checkout --track origin/integ-publish
71
+
72
+ # installing
73
+ ./scripts/package.sh
74
+ ./scripts/install.sh
75
+
76
+ # combine the above
77
+ ./scripts/pack_and_install.sh
78
+ ```
79
+
80
+ - test changes
81
+ - [ ] any packages installed will be with verdaccio so don't use dendron-site
82
+
83
+ ## publish
84
+
85
+ - checkout
86
+ ```
87
+ gco master
88
+ setRegRemote
89
+ ```
90
+
91
+ - [ ] cherry pick if needed
92
+
93
+ ```
94
+ version=minor
95
+ lerna version $version
96
+ lerna publish from-package
97
+ lerna publish from-package --ignore-scripts
98
+ ```
99
+
100
+ - pull in new changes
101
+ ```
102
+ git reset --hard
103
+ git clean -f
104
+ gco master
105
+ sleep 60
106
+ ./scripts/pack_and_install.sh
107
+ ```
108
+
109
+ ## re-publish
110
+
111
+ ```sh
112
+ ./unpublish.sh
113
+ lerna publish from-package --ignore-scripts
114
+ ```
115
+
116
+ ## cleanup
117
+ ```
118
+ cd $WORKSPACE_BUILD
119
+ gbD integ-publish
120
+
121
+ cd $WORKSPACE
122
+ gbD integ-publish
123
+ ```
124
+
125
+
126
+ ## cook
127
+
128
+ ### unpublish a package
129
+
130
+ ```
131
+ ./unpublish.sh
132
+ ```
133
+
134
+ ## rest
135
+
136
+ ### git
137
+ ```sh
138
+
139
+ yarn
140
+ yarn bootstrap:build
141
+ . bootstrap/scripts/helpers.sh
142
+
143
+ ```

Added: vault/dendron.pro.dendron-plugin.internal.lookup.md

vault/dendron.pro.dendron-plugin.internal.lookup.md ADDED
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: f528e8ad-a3f9-4f66-af1d-0af400014383
3
+ title: Lookup
4
+ desc: ''
5
+ updated: 1610206601056
6
+ created: 1610205567544
7
+ ---
8
+
9
+ ## Summary
10
+
11
+
12
+ ## Code
13
+
14
+ ### updateItems
15
+
16
+ ```ts
17
+ onUpdatePickerItem {
18
+ if picker.justActivated {
19
+ modify picker value to be current parent
20
+ }
21
+
22
+ @showRootResults if querystring = ""
23
+
24
+ items = picker.items
25
+ updatedItems = filterDefault(items)
26
+ updatedItems = createPickerItemsFromEngine()
27
+
28
+ // check for single letter queries
29
+ if no activeItems and querystring.length = 1 {
30
+ picker.items = updatedItems
31
+ return;
32
+ }
33
+
34
+ if $noteQuery {
35
+ // add schema to suggestion
36
+ // ...
37
+ }
38
+
39
+ // empty results
40
+ if !updatedItems {
41
+ return
42
+ }
43
+ }
44
+ ```
45
+
46
+ ### createPickerItemsFromEngine
47
+
48
+ ```ts
49
+ createPickerItemsFromEngine {
50
+ resp = await engine.queryNotes
51
+ ...
52
+ }
53
+ ```

Added: vault/dendron.pro.dendron-plugin.internal.md

vault/dendron.pro.dendron-plugin.internal.md ADDED
@@ -0,0 +1,160 @@
1
+ ---
2
+ id: 4b8f0470-dacb-433b-8d0c-f5a7d8f5245d
3
+ title: Lookup
4
+ desc: ''
5
+ updated: 1610160273101
6
+ created: 1608838048476
7
+ ---
8
+ ```ts
9
+ show {
10
+ quickpick := create
11
+ provider := new LookupProvider
12
+ @refreshButtons
13
+ @updatePickerBehavior
14
+ provider.provide quickpick
15
+ quickpick.show
16
+ }
17
+ ```
18
+
19
+ ```ts
20
+ refreshButtons(buttons) {
21
+ @state.buttonsPrev = quickpickButtons
22
+ quickpick.buttons = buttons
23
+ }
24
+ ```
25
+
26
+ ```ts
27
+ updatePickerBehavior {
28
+ @updateBehaviorByEffect
29
+
30
+ if changedNoteType {
31
+ @updateBehaviorByNoteType
32
+ }
33
+
34
+ if changedFilterType
35
+ @provider.onUpdatePickerItem
36
+
37
+ quickpick.oncreate :=
38
+ }
39
+ ```
40
+
41
+ ## Example
42
+
43
+ ### Normal
44
+
45
+ - show
46
+ - updatePickerBehavior
47
+ - source: updateBehaviorByNoteType(normal)
48
+
49
+ ### Change Value
50
+
51
+ - updatePickerBehavior
52
+ - source: onValueChange
53
+
54
+ ## Ref
55
+
56
+ ### Times when Picker is Updated
57
+
58
+ - onUpdatePickerItem
59
+ - lc.show, on init
60
+ - lc.updateBehaviorByNoteType, note type toggle
61
+ - lc.updatePickerBehavior, direct filter toggle
62
+
63
+ ### sources
64
+
65
+ #### UPDATE_PICKER_FILTER
66
+
67
+ - when direct filter has changed
68
+
69
+ #### updatePickerBehavior
70
+
71
+ - when changing note type
72
+ - values
73
+ - normal
74
+ - journal
75
+ - scratch
76
+
77
+ ## Lookup: onButton
78
+
79
+ - src/components/lookup/LookupControllerV2.ts
80
+
81
+ ```ts
82
+ onTriggerButton {
83
+
84
+ }
85
+ ```
86
+
87
+ # TreeView
88
+
89
+ ## init
90
+
91
+ - onInitialize, reconstruct the whole tre
92
+
93
+ ## refresh
94
+
95
+ - ReloadIndex
96
+ - SchemaWatcher
97
+ - FileWatcher
98
+
99
+
100
+ # Welcome Message
101
+
102
+ - file: plugin-core/src/\_extension.ts
103
+
104
+ ```ts
105
+
106
+ showWelcomeOrWhatsNew {
107
+ previousVersion := config.get(dendron.version)
108
+ version :=
109
+
110
+ // 1st install
111
+ if !previousVersion {
112
+ config.set(GLOBAL_STATE.VERSION, version)
113
+ config.set(GLOBAL_STATE.VERSION_PREV, 0.0.0)
114
+ return showWelcome()
115
+ }
116
+
117
+ // not 1st install
118
+ if (version != previousVersion) {
119
+ config.set(GLOBAL_STATE.VERSION, version)
120
+ config.set(GLOBAL_STATE.VERSION_PREV, previousVersion)
121
+ showInformationMessage(dendron has upgraded)
122
+
123
+ }
124
+ }
125
+
126
+ ```
127
+
128
+ ## SetupWorkspace
129
+
130
+ - note: `dendron.code-workspace` is completely overwritten when running setup
131
+
132
+ # Vault Add
133
+
134
+ - src/commands/VaultAddCommand.ts
135
+
136
+ ```ts
137
+ execute:
138
+ vaults = handleRemote
139
+
140
+ handleRemote:
141
+ repoDir :=
142
+ ensureDir(repoDir)
143
+ git clone gitRepo
144
+ vaults := repoDir
145
+ vaults.map { addVaultToWorkspace }
146
+
147
+ addVaultToWorkspace vault:
148
+ createVault(vault)
149
+ addToWorkspaceFile(vault)
150
+ ```
151
+
152
+
153
+ # Reload Index
154
+
155
+ ```ts
156
+ ws.getEngine()
157
+ engine.vaultsv3.map {
158
+
159
+ }
160
+ ```

Added: vault/dendron.pro.dendron-plugin.internal.startup.md

vault/dendron.pro.dendron-plugin.internal.startup.md ADDED
@@ -0,0 +1,128 @@
1
+ ---
2
+ id: 8d09cc3f-25e3-42a2-ac86-82806c0c8c65
3
+ title: Startup
4
+ desc: ''
5
+ updated: 1610160307560
6
+ created: 1610160007286
7
+ ---
8
+
9
+ ## Summary
10
+ - check for dendron.code-workspace
11
+ - start engine (local server that does indexing)
12
+ - reload workspace (connect to the local server)
13
+ - activate file watchers
14
+
15
+ ## Code
16
+ - file: plugin-core/src/_extension.ts
17
+
18
+
19
+ ### Check for workspace
20
+
21
+ ```ts
22
+ _activate {
23
+ ws := DendronWorkspace.getOrCreate
24
+
25
+ if ws.isActive {
26
+ port = startServer
27
+ updateEngineAPI(port)
28
+ startLSPClient
29
+ ws.reloadWorkspace // 312
30
+ ws.activateWatchers
31
+ }
32
+
33
+ }
34
+ ```
35
+
36
+ ### Reload Workspace
37
+
38
+ ```ts
39
+ // 49
40
+ reloadWorkspace {
41
+ ws.reloadWorkspace
42
+ if isFirstInstall {
43
+ showTutorial
44
+ }
45
+ postReloadWorkspace
46
+ emit(extension, initialized)
47
+ }
48
+ ```
49
+
50
+ #### postReloadWorkspace
51
+
52
+ ```ts
53
+ postReloadWorkspace {
54
+ ws :=
55
+ previousWsVersion = config.get(WORKSPACE_STATE.WS_VERSION)
56
+
57
+ if previousWsVersion == 0.0.0 {
58
+ execute(Upgrade)
59
+ config.set(WORKSPACE_STATE.WS_VERSION, ws.version)
60
+ } else {
61
+ newVersion :=
62
+ if (newVersion > previousWsVersion) {
63
+ execute(Upgrade)
64
+ config.set(WORKSPACE_STATE.WS_VERSION, ws.version)
65
+ emit(extension, upgraded)
66
+ }
67
+ }
68
+ }
69
+
70
+ ```
71
+
72
+ ## Reference
73
+
74
+ ### getOrCreate
75
+
76
+ ```ts
77
+ if !_DendronWorkspace
78
+ _DendronWorkspace = new DendronWorkspace
79
+ ```
80
+
81
+ ```ts
82
+ constructor {
83
+ @_setupCommands
84
+ ...
85
+ }
86
+ ```
87
+
88
+ ### startServer
89
+ - file: src/_extension.ts:
90
+ - related: [[launch|dendron.pro.dendron-api-server.internal#launch]]
91
+
92
+ ```ts
93
+ startServer {
94
+ maybePort :=
95
+ if !maybePort {
96
+ launch()
97
+ }
98
+ }
99
+ ```
100
+
101
+ ### updateEngine
102
+ - [[workspace.vaults|dendron.pro.dendron-plugin.internal#workspacevaults]]
103
+
104
+ ```ts
105
+ class EngineAPIService {
106
+ create {
107
+ const vaults =
108
+ DendronWorkspace.instance().vaults?.map((ent) => ent.fsPath) || [];
109
+ DendronEngineClient.create({ vaults, ws, port, history })
110
+ }
111
+ }
112
+ ```
113
+
114
+ ### workspace.vaults
115
+
116
+ ```ts
117
+ get vaults {
118
+
119
+ }
120
+
121
+ ```
122
+
123
+
124
+ ### ws.reloadWorkspace
125
+
126
+ ```ts
127
+ executeCommand(RELOAD_INDEX)
128
+ ```

Added: vault/dendron.pro.dendron-plugin.md

Files changed (1) hide show
  1. vault/dendron.pro.dendron-plugin.md +39 -0
vault/dendron.pro.dendron-plugin.md ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: 87d90002-f480-45eb-a8c4-d00df4d61557
3
+ title: Dendron Plugin
4
+ desc: ''
5
+ updated: 1611160743812
6
+ created: 1605375348464
7
+ ---
8
+ ## Activation
9
+
10
+ - check if we have an active dendron workspace
11
+
12
+ # Cook
13
+
14
+ ### Create a new Command
15
+
16
+ 1. Add command to `DENDRON_COMMANDS` under `plugin-core/src/constants.ts`
17
+ 2. Open the command prompt, enter `Run Task`, and run `gen:config`
18
+ - this will add the command to `package.json`
19
+ 3. Create the new command in `plugin-core/src/commands/{COMMAND_NAME}.ts`
20
+ - you can copy the contents of an existing command (eg. `src/commands/ShowHelp.ts`) to help you get started
21
+ 4. Write tests
22
+ - tests are in `plugin-core/src/test/suite-integ/{COMMAND}`
23
+ - testing instructions are [[here|dendron.dev.testing]]
24
+ 5. Write command logic
25
+ 6. If it makes sense, add a keyboard shortcut for the command. Make sure it doesn't conflict with an generic VSCode command or existing Dendron commands. You can detect existing keybindings by using the guide [here](https://code.visualstudio.com/docs/getstarted/keybindings#_detecting-keybinding-conflicts)
26
+ 7. Add command to `src/commands/index.ts`
27
+ 8. Submit pull request
28
+
29
+ ### Create a new Pod
30
+
31
+ 1. setting up dev environment and getting started: https://dendron.so/notes/81da87be-2d4e-47b5-a1d6-c0d647e1ab00.html
32
+ 1. sample code for json export pod: https://github.com/dendronhq/dendron/blob/master/packages/pods-core/src/builtin/JSONPod.ts#L143:L143
33
+ 1. what you will get from `prepareNotesForExport`: https://dendron.so/notes/0db94b86-d5c2-4e70-8f61-1a686fa8cc1d.html
34
+ 1. anki pod: take notes and transform them to anki format
35
+
36
+ # Dev
37
+
38
+ You can control the log level in the workspace settings using `dendron.logLevel`. This sets the log level for the plugin and well any server it launches. You will need to restart the workspace for the log level to take effect.
39
+

Added: vault/dendron.pro.dendron-plugin.qa.md

vault/dendron.pro.dendron-plugin.qa.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: c84aa95c-83b9-4d52-90a1-eeec8f0ca84f
3
+ title: QA
4
+ desc: ''
5
+ updated: 1609716111365
6
+ created: 1609713960639
7
+ ---
8
+ ### Writing Tests
9
+
10
+ When writing a test for new functionality, make sure to consider both the `single` vault and `multi-vault` scenario.
11
+
12
+ To write a test, use the `runLegacySingleWorkspaceTest` or `runLegacyMultiWorkspaceTest` methods to setup a mock Dendron workspace of the respective type.
13
+
14
+ You can see an example of both in [plugin-core/src/test/suite-integ/RenameNoteV2.test.ts](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/suite-integ/RenameNoteV2.test.ts#L131:L131)
15
+
16
+ The arguments are explained [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/testUtilsV3.ts#L70:L70).
17
+
18
+ ### Test Runner
19
+
20
+ Note that VSCode uses [mocha](https://mochajs.org/) as its default test runner whereas Dendron uses [jest](https://jestjs.io/).
21
+
22
+ We shim the [jest methods](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/testUtilsv2.ts#L418:L418) when testing the plugin though so that we can re-use the same logic between our non-vscode packages and the Dendron VSCode Plugin.
23
+

Added: vault/dendron.pro.dendron-plugin.ref.lifecycle.md

vault/dendron.pro.dendron-plugin.ref.lifecycle.md ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ id: d410c0d6-9ede-42ef-9c96-662902e4f488
3
+ title: Lifecycle
4
+ desc: ''
5
+ updated: 1611428138285
6
+ created: 1609714449234
7
+ ---
8
+
9
+ ## Workspace Creation
10
+
11
+ This describes everything that happens after a user runs `Initialize Workspace`. See source code [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/SetupWorkspace.ts#L37:L37).
12
+
13
+ ## Running a Command
14
+
15
+ When a command is executed, it runs the following functions in order. Source code [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/base.ts#L40:L40)
16
+
17
+ - sanityCheck: does basic checks
18
+ - enrichInputs: cleans up passed in inputs
19
+ - execute: runs the actual command
20
+ - showResponse: show response to the user
21
+
22
+
23
+ ## Activate
24
+ - activating dendron involves the following steps
25
+ - dendron api server started
26
+ - dendron engine finish indexing notes
27
+
28
+ - extension, initialized: engine is loaded
29
+
30
+ - other
31
+ - extension, not_initialized: error with starting engine

Added: vault/dendron.pro.dendron-plugin.ref.md

vault/dendron.pro.dendron-plugin.ref.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 37313fad-34e1-4db9-8716-335499bdd698
3
+ title: Ref
4
+ desc: ''
5
+ updated: 1609716274826
6
+ created: 1609716274826
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.pro.dendron-preview.deploy.md

vault/dendron.pro.dendron-preview.deploy.md ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ id: fb2cfc7e-f71d-4ec6-8c17-90f323a6c075
3
+ title: Deploy
4
+ desc: ''
5
+ updated: 1614534579472
6
+ created: 1614031837862
7
+ ---
8
+
9
+
10
+ ### setup mume
11
+ ```
12
+ cd $MUME_WORKSPACE
13
+ gbD integ-publish
14
+ gco -b integ-publish
15
+ setRegLocal
16
+ ./scripts/relink.sh
17
+ ./scripts/bump.sh
18
+ ```
19
+
20
+ ### setup preview
21
+ ```
22
+ cd $PREVIEW_WORKSPACE
23
+ ./scripts/relink.sh
24
+
25
+ git add .
26
+ git commit -m "chore: bump deps"
27
+
28
+ gbD integ-publish
29
+ gco -b integ-publish
30
+ scripts/bump-pkg-install.sh
31
+ ```

Added: vault/dendron.pro.dendron-preview.md

vault/dendron.pro.dendron-preview.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ id: 92df74a7-39e7-453a-b940-013f3a48f513
3
+ title: Dendron-preview
4
+ desc: ''
5
+ updated: 1611516193599
6
+ created: 1607127810303
7
+ ---
8
+

Added: vault/dendron.pro.dendron-preview.setup.md

vault/dendron.pro.dendron-preview.setup.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 59c41809-f3e9-457a-8b2c-7daecf7d338f
3
+ title: Setup
4
+ desc: ''
5
+ updated: 1611516203773
6
+ created: 1611516198276
7
+ ---
8
+
9
+
10
+ - TODO

Added: vault/dendron.pro.dendron-snippet-maker.md

vault/dendron.pro.dendron-snippet-maker.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: 89980f03-f5fd-4c9a-8325-c450c1108150
3
+ title: Dendron Snippet Maker
4
+ desc: ''
5
+ updated: 1599700231902
6
+ created: 1599700231902
7
+ stub: false
8
+ ---
9
+ This is a standalone extension used by Dendron to help you more easily create snippets.
10
+
11
+ # Commands
12
+
13
+ ### Create Global Snippet
14
+
15
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/snippet.create.gif)
16
+
17
+ #### Goto Global Snippet
18
+
19
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/snippet.goto.gif)
20
+

Added: vault/dendron.pro.devto-pod.md

Files changed (1) hide show
  1. vault/dendron.pro.devto-pod.md +57 -0
vault/dendron.pro.devto-pod.md ADDED
@@ -0,0 +1,57 @@
1
+ ---
2
+ id: c6adf905-2f74-4235-a2dc-c85b4711ea4a
3
+ title: Dev.to Pod
4
+ desc: ''
5
+ updated: 1614313013455
6
+ created: 1614191155933
7
+ ---
8
+
9
+ ## Summary
10
+
11
+ This pod lets you publish your Dendron notes to dev.to
12
+
13
+ - id: `dendron.devto`
14
+ - [github](https://github.com/dendronhq/devto-pod)
15
+ - coverage
16
+ - ❌ export
17
+ - ❌ import
18
+ - ✅ publish
19
+
20
+ ## Instructions
21
+
22
+ ### Installation
23
+ ```sh
24
+ cd {workspace}
25
+ npm init -y
26
+ npm install -g dendron-cli
27
+ npm install --save @dendronhq/devto-pod
28
+ ```
29
+
30
+ ### Usage
31
+
32
+ The below command will publish $FILE_NAME to Dev.To
33
+
34
+ ```sh
35
+
36
+ API_KEY={API_KEY}
37
+ FILE_NAME={FNAME}
38
+
39
+ cd {workspace}
40
+ dendron-cli publishPod --wsRoot . --podId dendron.devto --podPkg @dendronhq/devto-pod --podSource custom --config fname=$FILE_NAME,vaultName=vault,dest=stdout,apiKey=$API_KEY
41
+ ```
42
+
43
+ ## Configuration
44
+
45
+ - apiKey: the API Key of your dev.to account. You can follow the instructions [here](https://docs.forem.com/api/#section/Authentication) to get it
46
+
47
+ ## Metadata
48
+
49
+ The following values are used when publishing your post.
50
+
51
+ * title: string
52
+ - source: frontmatter, title field
53
+ - note title
54
+ * tags?: string[];
55
+ - source: frontmatter, `tags` field
56
+ * canonical_url?: string;
57
+ - source: `dendron.yml`, obtained from `site.site_url`

Added: vault/dendron.pro.markdown-links.md

vault/dendron.pro.markdown-links.md ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ id: 9af9cf56-d2a0-47d1-b8bf-5a02c42ac2fd
3
+ title: Markdown Links
4
+ desc: ''
5
+ updated: 1611516225457
6
+ created: 1608753702392
7
+ ---

Added: vault/dendron.pro.markdown-links.setup.md

vault/dendron.pro.markdown-links.setup.md ADDED
@@ -0,0 +1,32 @@
1
+ ---
2
+ id: 85dace70-c2ef-46e9-b467-8d297c420421
3
+ title: Setup
4
+ desc: ''
5
+ updated: 1614924050222
6
+ created: 1611516225361
7
+ ---
8
+ ## Getting Started
9
+
10
+ 1. Install dependencies
11
+ ```bash
12
+ git clone https://github.com/dendronhq/markdown-links.git
13
+ cd markdown-links
14
+ npm install
15
+ ```
16
+ 2. Use `Run Extension` from the [[debug pane|dendron.dev.ref.vscode#debug-pane]] (note: this requires that dendron be installed. VSCode might ask you to install Dendron and reload at this point)
17
+ 3. Make sure you are inside a Dendron workspace. If not, either initialize one using `Dendron: Initialize Workspace` or change to one using `Dendron: Change Workspace`
18
+
19
+ ## Setup without Dendron Extension Installed
20
+
21
+ Dendron markdown links depends on the dendron extension to be active. You can still make it work without the extension by the following instructions:
22
+
23
+ 1. Comment out the following in `package.json`
24
+ ```json
25
+ "extensionDependencies": [
26
+ "dendron.dendron"
27
+ ],
28
+ ```
29
+ 2. Follow step 2 in the setup instructions above.
30
+ 3. Instead of using the plugin to initialize a Dendron workspace, initialize the workspace using the `dendron-cli`
31
+ ((ref:[[dendron.topic.cli]]#launchengineserver,1:#*))
32
+

Added: vault/dendron.pro.md

Files changed (1) hide show
  1. vault/dendron.pro.md +11 -0
vault/dendron.pro.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 32cdd4aa-d9f6-4582-8d0c-07f64a00299b
3
+ title: Related Projects
4
+ desc: ''
5
+ updated: 1604511830312
6
+ created: 1596684856906
7
+ stub: false
8
+ nav_order: 10
9
+ ---
10
+
11
+

Added: vault/dendron.pro.pods.md

Files changed (1) hide show
  1. vault/dendron.pro.pods.md +13 -0
vault/dendron.pro.pods.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ id: fd58336c-27ae-4334-945c-8c782a6bc36b
3
+ title: Pods
4
+ desc: ''
5
+ updated: 1613845633407
6
+ created: 1613845605602
7
+ ---
8
+
9
+ This describes dendron [[pOds|dendron.topic.pod]] functionality
10
+
11
+
12
+ ## Export Port
13
+

Added: vault/dendron.quickstart.md

Files changed (1) hide show
  1. vault/dendron.quickstart.md +49 -0
vault/dendron.quickstart.md ADDED
@@ -0,0 +1,49 @@
1
+ ---
2
+ id: e86ac3ab-dbe1-47a1-bcd7-9df0d0490b40
3
+ title: QuickStart
4
+ updated: 1609992432166
5
+ created: 1595170096361
6
+ nav_order: 1
7
+ ---
8
+ This guide will help get you started with Dendron.
9
+
10
+ ## Pre-requisites
11
+
12
+ - [[Install Dendron|dendron.guides.install]]
13
+ <!-- - Get familiar with the [basics](https://code.visualstudio.com/docs/editor/codebasics) of VSCode, an open source [IDE](https://www.codecademy.com/articles/what-is-an-ide) from Microsoft (and what Dendron is built on top of) -->
14
+
15
+ ## The Trail 🥾
16
+
17
+ This section covers the basics of Dendron. Get started on the right foot and start growing your knowledge base.
18
+
19
+ - [ ] Go through Dendron's basic [[concepts|dendron.concepts]]
20
+ - [ ] Do your first [[lookup|dendron.topic.lookup]] - a better way to find your notes
21
+ - [ ] Learn about [[schemas|dendron.topic.schema]] - a flexible type system for all your notes
22
+ - [ ] Use a [[snippet|dendron.topic.snippets]]
23
+ - [ ] Insert an [[image|dendron.topic.images]]
24
+ - [ ] Create some [[links|dendron.topic.links]]
25
+ - [ ] Explore additional features from [[Dendron's bundled extensions|dendron.topic.extensions]]
26
+ - [ ] [[Publish|dendron.topic.publishing]] your vault
27
+ - [ ] Join us on [discord](https://discord.com/invite/6j85zNX) and discuss all things knowledge management with your fellow trail blazers.
28
+
29
+ ## The Woods 🌲
30
+
31
+ This section covers advanced functionality in Dendron. Become a seasoned backpacker by mastering these trails.
32
+
33
+ - [ ] Check out our [[case studies|dendron.case-studies]]
34
+ - [ ] Read our [[FAQ|dendron.faq]]
35
+ - [ ] Explore the [[graph view|dendron.topic.graph-view]]
36
+ - [ ] Execute custom [[Dendron commands|dendron.topic.commands]]
37
+ - [ ] Understand [[frontmatter|dendron.topic.frontmatter]]
38
+ - [ ] Adopt a [[pod|dendron.topic.pod]]
39
+ - [ ] Create a [[special note|dendron.topic.special-notes]]
40
+
41
+ ## The Wilderness ⛰️
42
+
43
+ This section covers additional topics and the wider ecosystem around Dendron
44
+
45
+ - [ ] Find [[recipes|dendron.guides.cook]] to common operations (or contribute your own)
46
+ - [ ] Found an issue or want to submit a feature request? Do so on [github](https://github.com/dendronhq/dendron/issues)
47
+ - [ ] See and vote on what's coming next by checking out our [public roadmap](https://github.com/orgs/dendronhq/projects/1)
48
+ - [ ] Stay tuned for more wilderness coming soon!
49
+

Added: vault/dendron.recruit.md

Files changed (1) hide show
  1. vault/dendron.recruit.md +25 -0
vault/dendron.recruit.md ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: 0f9967bc-d657-496f-9b4b-d1c7ebfd496c
3
+ title: Recruitment Pitch
4
+ desc: ''
5
+ updated: 1599936705684
6
+ created: 1599936705684
7
+ stub: false
8
+ nav_exclude: true
9
+ ---
10
+ [Dendron](https://dendron.so) is a note taking tool build around flexible hierarchies and bi-directional linking. It is meant to be the fastest way for people to create, find, and collaborate on the information they care about.
11
+
12
+ All note taking tools make it easy for you to get information in. They all struggle to help you find that information once you've accumulated a good number of notes. Dendron is optimized to help you find your notes no matter how many notes you have (Kevin, the founder, uses Dendron to manage +20K notes, all of which he can access in seconds)
13
+
14
+ Dendron is open source and local-first, meaning that anyone can build their own version of Dendron and that your data always stays with you. We build Dendron this way because we believe that access to one's knowledge is intimately personal and that you, as the user, should always have **full control of your knowledge**.
15
+
16
+ > "We are overwhelmed with information and we don't have the tools to properly index and filter through it. [The development of these tools, which] will give society access to and command over the inherited knowledge of the ages [should] be the first objective of our scientist"
17
+ >
18
+ > - [Vannevar Bush](https://en.wikipedia.org/wiki/Vannevar_Bush), 1945
19
+
20
+ Dendron's goal is to give society **access to and command over the inherited knowledge of the ages.** We launched in preview in the summer of 2020 and have had awesome traction with early adopters. We currently have over a thousand downloads and a budding community of Dendronites from around the world.
21
+
22
+ To keep up with the growth of Dendronites while continuing to work towards our roadmap, we need help. We are looking for developers to help take Dendron to the next level.
23
+
24
+ Dendron is built in typescript on top of VSCode. Knowledge of either is not required (though definitely preferred). You would be working alongside [myself](https://www.kevinslin.com) as well as our [global community of Dendronites](https://discord.gg/6j85zNX) to build a better way for people to **create, find, and collaborate** on knowledge that matters to them.
25
+

Added: vault/dendron.ref.intellisense.md

Files changed (1) hide show
  1. vault/dendron.ref.intellisense.md +14 -0
vault/dendron.ref.intellisense.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ id: 032e4abc-f292-465f-9b6a-5a1360c2c974
3
+ title: Intellisense
4
+ desc: ''
5
+ updated: 1599755804490
6
+ created: 1599755804490
7
+ stub: false
8
+ ---
9
+ Intellisense is the auto completion mechanism used inside VSCode.
10
+
11
+ You can read the docs about it [here](https://code.visualstudio.com/docs/editor/intellisense#_intellisense-features).
12
+
13
+ To customize intellisense behavior, read the section on customization [here](https://code.visualstudio.com/docs/editor/intellisense#_customizing-intellisense)
14
+

Added: vault/dendron.ref.layout.md

Files changed (1) hide show
  1. vault/dendron.ref.layout.md +58 -0
vault/dendron.ref.layout.md ADDED
@@ -0,0 +1,58 @@
1
+ ---
2
+ id: 3bff1195-1d13-4e7a-bc2f-7e4cc617109c
3
+ title: Layout
4
+ desc: ''
5
+ updated: 1614202013214
6
+ created: 1596740451789
7
+ stub: false
8
+ ---
9
+ ## File Tree
10
+
11
+ ### Basic
12
+ ```
13
+ .
14
+ ├── dendron.code-workspace
15
+ ├── dendron.yml
16
+ ├── .dendron.port
17
+ ├── .dendron.meta
18
+ ├── docs/
19
+ ├── .gitignore
20
+ └── vault/
21
+ ├── root.md
22
+ ├── root.schema.md
23
+ ├── dendron.md
24
+ ├── dendron.faq.md
25
+ ├── ...
26
+ └── assets/images
27
+ ```
28
+
29
+ - dendron.code-workspace
30
+ - vscode and dendron configuration
31
+ - dendron.yml
32
+ - dendron specific settings
33
+ - .dendron.port
34
+ - writes the port that the [[dendron engine|dendron.pro.dendron-engine]] is listening to
35
+ - .dendron.meta
36
+ - writes dendron specific metadata
37
+ - .gitignore
38
+ - add special notes
39
+ - docs/
40
+ - used to generate a static site from your vault
41
+ - vault/
42
+ - `root.md `
43
+ - generated by dendron, root of all your hierarchies
44
+ - `root.schema.yml`
45
+ - generated by dendron, root of all of your schemas
46
+ - assets/images
47
+ - default for `Dendron Paste Image` extension to put images in
48
+
49
+ ## Terms
50
+
51
+ ### workspace root
52
+ This is the folder where `dendron.code-workspace` is located
53
+
54
+ ## Additional Folders
55
+
56
+ - pods: [[pod|dendron.topic.pod]] related files
57
+ - seeds: [[seeds|dendron.topic.seeds]] related files
58
+ - repos: used by dendron to store [[remote vaults|dendron.concepts#remote-vault]]

Added: vault/dendron.ref.md

Files changed (1) hide show
  1. vault/dendron.ref.md +10 -0
vault/dendron.ref.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: f308164e-faff-43a1-8d34-72ed060275b0
3
+ title: Reference
4
+ desc: ''
5
+ updated: 1615227295669
6
+ created: 1596740440387
7
+ nav_exclude: true
8
+ ---
9
+
10
+

Added: vault/dendron.ref.terms.md

Files changed (1) hide show
  1. vault/dendron.ref.terms.md +27 -0
vault/dendron.ref.terms.md ADDED
@@ -0,0 +1,27 @@
1
+ ---
2
+ id: 20b23165-d803-4eb2-98aa-0f0934dd3bd9
3
+ title: Terms
4
+ desc: ''
5
+ updated: 1614057590921
6
+ created: 1610064859384
7
+ ---
8
+
9
+
10
+ ### Slug
11
+
12
+ Human readable part of url. See [wikipedia article](https://en.wikipedia.org/wiki/Clean_URL#Slug) for more details.
13
+
14
+ Dendron uses [github-slugger](https://github.com/Flet/github-slugger) to generate slugs.
15
+
16
+
17
+ ### Pretty Ref
18
+
19
+ A pretty ref is a [[note ref|dendron.topic.refs]] rendered with an outline.
20
+
21
+ You can see an example below
22
+
23
+ ![Pretty Note refs](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.note-ref-pretty.jpg)
24
+
25
+ A regular note ref is embedded inline in the text.
26
+
27
+ ![Regular Note Ref](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.note-ref-normal.jpg)

Added: vault/dendron.ref.titles.md

Files changed (1) hide show
  1. vault/dendron.ref.titles.md +21 -0
vault/dendron.ref.titles.md ADDED
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: 554023aa-e21d-4082-8239-a1032ac54e61
3
+ title: Titles
4
+ desc: ''
5
+ updated: 1609783328053
6
+ created: 1609783322468
7
+ ---
8
+ We recommend using all lower kebab case when naming your files. For example, `awesome apples` would be `awesome-apples`. This would be stored in your file system as `awesome-apples.md`.
9
+
10
+ Dendron will auto-generate a human friendly title based on the last part of your hierarchy. By default, Dendron uses [title.sh](https://title.sh/) to generate titles based on your note name. Titles generated are consistent with the [Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html). Dendron will replace `-` with a ` ` when generating titles.
11
+
12
+ If you end up adding custom capitalization to your file name, Dendron will not attempt to generate a title but return the last part of your hiearchy as is.
13
+
14
+ Some examples below:
15
+
16
+ ```
17
+ - awesome-apples.md -> title: Awesome Apples
18
+ - fruit.awesome-apples.md -> title: Awesome Apples
19
+ - fruit.Custom-Capitalization -> title: Custom-Capitalization
20
+ ```
21
+

Added: vault/dendron.ref.transcript.md

Files changed (1) hide show
  1. vault/dendron.ref.transcript.md +266 -0
vault/dendron.ref.transcript.md ADDED
@@ -0,0 +1,266 @@
1
+ ---
2
+ id: 097cf7ed-e9aa-4580-86cf-0347bf7a623d
3
+ title: Dendron Onboarding Transcript
4
+ desc: ''
5
+ updated: 1599235587751
6
+ created: 1599235587751
7
+ stub: false
8
+ ---
9
+ 0:00
10
+ So getting started? And have you had a chance to play around with engine at all, or this is the first time.
11
+
12
+ 0:07
13
+ Um, I've opened it and read a little bit of the doc in it. And that's all I've done.
14
+
15
+ 0:13
16
+ Okay, cool. That's perfect. And so right now,
17
+
18
+ 0:17
19
+ when you turned up in the, in the, in the couple of discord threads was really the first point that I looked at it at all, and I haven't spent much time looking. And then you throw this out, like, Okay, this jumpstart.
20
+
21
+ 0:33
22
+ Cool. Yeah. And that's kind of what this onboarding is for. It's, it's, you know, today's help, even if you haven't even opened it up just to give you the idea of, you know, why you might want to. And so right now, what you're looking at is identity and workspace, and the way so let's back up and tension. We manage your notes and our work states and if you use VS code, it's the equivalent of the VS code workspace. So that's a one to one match in there. And the way that you start off is you can initialize the workspace. And right now, I did me, we can just make a new one, like lead you. And so this is saying the workspace should be at this location. And so when we create a workspace, we can either create one with intention tutorial notes, and that has right or you can do an empty one. So I'm just going to do an empty one in this case. And so when you create an empty workspace, you have one file, which is the root file. And this is just there for this is kind of like your phone. And the way that denture and works is if you want to create a file, you can just type command L. I'm going to toggle screencast mode, command l triggers to look up bar, and most of the things you'll do in engine will involve this one have you used tools like Notational Velocity no So Notational Velocity, it's it was a tool where basically when you are looking for a file, for example, if I type Python, if the file doesn't exist, then it creates it for you. If it does, if that if it does exist, it will fetch it. So it's this idea that you never really have to think about
23
+
24
+ 2:22
25
+ the accessing your data.
26
+
27
+ 2:26
28
+ And
29
+
30
+ 2:27
31
+ so I'm assuming that dendron is putting the is that a YAML? header?
32
+
33
+ 2:33
34
+ Yes, that is a yamo header.
35
+
36
+ 2:35
37
+ So it's just automatically doing that when it creates the file.
38
+
39
+ 2:39
40
+ Exactly.
41
+
42
+ 2:41
43
+ And for the yamo header, the idea here is we store some metadata. So every node has a unique ID. And the reason we do that is because if you choose to you can publish your notes. That's my local version that this is the engine website is actually a published vault.
44
+
45
+ 2:59
46
+ Ah, Why. So I created a
47
+
48
+ 3:03
49
+ workspace with the with the help notes. Yeah. So that's why it looks the same.
50
+
51
+ 3:10
52
+ Yep, exactly. And it is generated from the notes. And the reason and if you notice the IDs for each note, when you publish the notes are actually published by their ID not by the name. And what's nice about that is even if you've renamed the notes, as long as you keep the frontmatter, it will show publish to the same URL.
53
+
54
+ 3:29
55
+ Interesting,
56
+
57
+ 3:30
58
+ okay. And, okay, so, and as I'm battling off, if at any point, you want to just like stop me and say, like, hey, like, what's this? What would you guess? Do you just feel free to I tend to otherwise just keep talking?
59
+
60
+ 3:42
61
+ Oh, no, that's fine. That's exactly what I was hoping. Okay,
62
+
63
+ 3:45
64
+ okay. Um, so creating, so as far as creating notes, you can type it. If it exists, it'll fetch it. If it doesn't then it it will create a another way of creating notes as using wiki links, which is double bracket syntax. So for example, if I wanted to go to Ruby, I could type in Ruby. And then if you do the go to definition shortcut, then you can go to default on Mac is something different. I just changed it to Ctrl, enter. So if I do Ctrl, enter, I can go into Ruby, sometimes some markdown preview, well, like, not update right away. But in, for example, in groovy, I can type in Python, and I can go here and I can go back to Python. And making these links, it's kind of the same thing as look up in like JavaScript, for example, JavaScript doesn't exist. But if I navigate to it, then venturing well creatively.
65
+
66
+ 4:42
67
+ That's kind of the same way obsidian works.
68
+
69
+ 4:47
70
+ And it's just this idea that you shouldn't be thinking about the order of files. It's, you know, not likely and notetaking should just be the information that you're working with. And as far as bi directional linking On the left hand panel, so we have a backlink section. And the backlinks section shows you all the notes that this note is linked by. And so in Python, it's showing you that hey, Ruby links do Python. Yep. And I think obsidian has a similar panel, but it's, yeah, it's a backlink panel. Now, the thing that Oh, and I guess one more thing before I get into hierarchies, we support let's see, this is header one.
71
+
72
+ 5:35
73
+ This is header Two,
74
+
75
+ 5:39
76
+ one.
77
+
78
+ 5:43
79
+ So denisha. We also support what we call defences, loan costs and block graph. I think loan costs and block references. We call them nodes references. I think obsidian also has a doe I'm not sure what they call it.
80
+
81
+ 5:58
82
+ I don't actually have this Same. There are references to headers and things, but they don't. It's a little different.
83
+
84
+ 6:07
85
+ Right? So what I'm going to show you is in dendron, you can embed notes and other notes. So for example, I just hit Command Shift R, which copy the left lens of this note, and the, and then I can paste it, for example in JavaScript. And so I'm seeing the Python notes embedded in the JavaScript note. You can either choose to reference a note, or you can choose to reference a header. So for example, everything starting from heading one, and you can also do games. So you can say everything starting from header one to header two, that you can embed notes into other nodes. And then the other thing that you can do is you if you keep bullets, the markdown preview is mutable in the sense that you can click on the lead and also update the markdown. Yes, that's a little thing that I find people get quite excited about that
86
+
87
+ 7:08
88
+ over if you're going to use to do if you're going to use those
89
+
90
+ 7:10
91
+ as to dues it's a big deal. Exactly. Um, okay, and now getting to the part. So right now what I've shown you it's pretty similar to obsidian it's pretty similar to go more like how normal note taking apps work. The things that dungeon the dungeon now starts doing differently is we're focused on having your notes conform to some sort of structure. And so that's not to say like, as you can see, like we support backlinks so you can link any note to any note. But the problem that I found and the reason why I made my own note taking tool is I find that once you get a lot of notes, you need some sort of structure, if you organize it, if it's all backlinks, like it becomes really hard to find something, whether it's a naming convention, whether it's some sort of hierarchy, like there need to be some sort of structure to help you find it. And so in Benjamin, for us that structure is hierarchy. So the way that you create a hierarchy, and Benjamin is whatever. So when you do command L, you the lookup bar gets populated by the current note that you're in. And so if you have not, then you're creating a new level in the hierarchy. So for example, I can do Python data. And so you know, this is a data node. But the hierarchy is, Python is parents data as a child. And under data, for example, I might want to do if I'm learning about Python, data could be you know, all of the various data structures that Okay, my path and setting I can look in billions and things. And the nice thing about this hierarchy is now instead of, you know, you manually having to link all the nodes together, because you are in the Python hierarchy, you can you have a bird's eye view of everything in this hierarchy.
92
+
93
+ 8:59
94
+ That's just kind of Gaining
95
+
96
+ 9:02
97
+ interest. Another way you can see the hierarchy is we have to show graph command. And so just like how obsidian has a graph, Python, now Python engine has a graph. But this is a graph with backlinks. It's a graph of your hierarchy. And so, you know, as you note, like there isn't a connection between Ruby and Python, even though there's a backlink, what this is showing you, you can think of it as a top down view of your table of contents of the hierarchies that you have. Right. Now, the nice thing about having this is like right now, for example, Python this in stone thing, that web engine lets you do, so let me back up for a moment. hierarchies, I find are one of the best ways of organizing notes by most people and most tools don't really support it as well. And that's because I think not because hacky some work, but because he had no tooling on our piece. Like if you had your files in a folder Actually, you could put them in a bunch of different folders, but then like finding them is more difficult. And then if you ever wanted to rename anything, that's just a nightmare. And so attention, we're building on this idea that it is actually some of the most effective ways of managing information with people. And we it's built around this idea that as hope you work with hierarchies, and one thing we let you view is we let you be factor. So for example, right now, I'm under a Python. But let's say that I shut off a entering text I want to replace. So I'm saying for Python instead of Python. Oops, let me again, instead of Python, go place Python with Lang Python. And what this is going to do is everywhere where you have python.md, it's going to add the Lang prefix for programming language. And if I hit proceed, proceed. What you'll notice is that not only did all the falaschi name but also If I go, for example, into movie, all the links to the palace, and also then. And so it's just an easier way of managing the hierarchies. And now, like, why might you want to do this? Well, because I have this just crazy thing. So because I have this programming language it, what it lets me do. And this is really what I started doing with my notes is, if I'm learning, for example, a programming language, and I'm working on like two or three at a time, it's really difficult to context switch between them. It's like, how do we do this in Ruby, how you listen to Python? What I found was much more conducive is if I could think like, okay, in a programming, what is my model for programming language. And so for example, a programming language has data structures, and so I could apply that to Ruby as well. So for example, for Ruby, it also has data structures. And then what I could do is when I'm learning about Ruby, you know, I could translate that higher He that I learned from Python, and put it into a movie. And what this lets me do now is, now it's a lot easier to context switch between different programming languages, because I'm thinking more about the concepts than the actual implementation. And for example, now, if I'm like in my hierarchy for So first of all, like, if I'm looking at data structures in Python, I have all of them in one view. But now let's say that I want to look up data structures for all my programming languages, then I also have a similar view for that. And so now, this idea, and this is where it really, for me, like, became like, the way that I did all my notes is having these hierarchies not only are they a great organizational scheme, because now instead of having 100, you know, 1000 notes at the top level, you only have, you know, the very good stuff behind this. So it's programming languages. It's cooking as you know. Few things that you care about at the top level, and you can drill down into them. And when you drill down into them, it's not just organizational. It's something that, for me, at least, it helps me learn about the topic. Because I find the heipiess that I create, for, you know, a programming language or anything, they affect my mental model of it. And I find over time, when I'm learning about things, it's not actually the implementation that matters, but it's the fact that I've been able to develop this hierarchy and then continue refining it over time.
98
+
99
+ 13:34
100
+ That makes sense. Well, there's nothing that keeps you from just having a bunch of loose notes at some, somewhere even if, even if it's nothing. If for the sake of cleanliness, you you create a hierarchy starting with Miss and stuff under it. You have the same thing you have typically totally get the language thing. I once had a situation where I had the word two computer assembly languages. Yeah. And one of them had right to left operation on the instructions. And the other had left to right, but three quarters and now, three quarters of the names of operations were the same. So you just had to remember whether you were in left, right or right, left. So yeah, I totally get that.
101
+
102
+ 14:28
103
+ And the other thing that I do for these notes, and let me just going to show you this is my one of my vaults. This is a notes for a meeting today. But for example, I have a CI and this is like all the CI commands that I run into, and it's not just necessary. Oh, okay. So that one. It's like, if I run into a problem instead of, you know, googling it,
104
+
105
+ 14:55
106
+ yeah.
107
+
108
+ 14:56
109
+ I don't know how half a cache of it. So if I run into the same problem, they And, you know, I can just go into that COI hierarchy.
110
+
111
+ 15:04
112
+ And right because it's the one, it's the one. I did that last month. I know I know that, but I don't remember.
113
+
114
+ 15:12
115
+ Exactly. And if you look at this, I think I have a couple of hundred different commands. And the nice thing about this as like, I did none of this, you know, ahead of time, it was kind of a just in time, I ran into cognitive work. I needed to Stack Overflow, it took me 10 minutes. I never want to spend time on it again. Let me go into, you know, yeah.
116
+
117
+ 15:36
118
+ Okay, cool.
119
+
120
+ 15:38
121
+ So, can we look a little bit at, um, kind of your to dues?
122
+
123
+ 15:44
124
+ Yeah. So, two dues let me actually, okay, I'm going to do two things. I'm first going to show you how you would create it from scratch and then I'll show you my two dues for the day. I like to organize things by projects. And so I usually have like a project hierarchy. Actually. And so for example, one project might be different. And so under dendron, what I actually do is I have a daily journal that I go over everything I need to do for that particular day. And let me think, what is the best way of showcasing, I'm just going to show you my to do actually.
125
+
126
+ 16:28
127
+ So this is my to do for a dendron.
128
+
129
+ 16:32
130
+ And let me show you and the video. And what I do is intention, you have this notion of your journal notes. And so journal notes is basically whatever hierarchy you're currently in, and appends journal to it in the current date. And this is configurable. You can change the date format, you can change how it appends it, but I'm going to move on to tomorrow's date. And the way you do that is Ctrl Shift J. But you can use that to create a new Going on it. And then what I do is every day, are you familiar with snippets inside VS code?
131
+
132
+ 17:07
133
+ Oh, I haven't used them inside VS code. I use external snippet code.
134
+
135
+ 17:14
136
+ Well, I, anyways, I use a bunch of snippets. And so apprehension journal snippet, and that will fill it out with
137
+
138
+ 17:21
139
+ Okay, might get the idea even though I haven't used it.
140
+
141
+ 17:25
142
+ Yeah. And then the way I do two dues that's worked really well. For me, if I'm just working by myself, I have a snippet to make this bullet. And then I'll write you know, task one, task two tasks week.
143
+
144
+ 17:38
145
+ Something that
146
+
147
+ 17:40
148
+ dension does fairly well is for example, sometimes like past one, it turns out to be a much bigger task and has a notion of sketch notes. And so let me and so this is all just special cases, it's you can create a sketch note by Command Shift s, and you can choose to add a title or not. If you don't add a title by default. It creates under your current high hierarchy denture and dots batch, and then the current date and timestamp. And you can think of this cache notice as caches, it's just, oh, I'm in a meeting, I need to take a note, I don't want to figure out where I'm gonna move it. So I'm just going to start you know, taking. And so that's kind of the purpose of discussion. And then later on, you can like rename it, and then follow it away somewhere if you want to. The more interesting thing is, if I highlight tasks, for example, and then I do the shortcut for a sketch note, what it does, is it creates a link from this task to the sketch note. And so now, you know, I can use this to create nested tasks. So you know, task 1.1 1.2 and if I find that, you know, task 1.1 is still too big, and I need to break it down even further. I can create another cash flow from that and then you know, create even more tasks. So you can go as deep as you want to that I usually find that to be To TCP level sign up yeah
149
+
150
+ 19:04
151
+ that deeper probably needs to be broken up
152
+
153
+ 19:08
154
+ and but what's really cool about this is you can start off with a bullet and you can still keep this nicely bulleted list but then you can you know, expand upon it as much as you need to. Um, but as far as like project management goes the way I manage projects is I have my daily to dues and then I look at my to dues from the previous day. And then like anything I haven't done the previous day, I will copy it over into today. And then I will I use a bullet journal format so like I will add like a lesson sign.
155
+
156
+ 19:47
157
+ Go No, I don't use it, but I'm familiar with it.
158
+
159
+ 19:51
160
+ And something else that you can do is this is VS code feature more than attention feature better And then most people don't know about this. If you notice, for example, I have tags to some of my tasks, what I can do VS code has a search editor feature where you can search within your current note. And so if I type in start, it shows me For example, all my lines were have to start counting. And what's cool about this is this search is globbing. And so what I can do is by I have this shortcut set up, that brings me a search of whatever the current notice, but I can, for example, go here to show me Okay, what are all my past titled start within this month? And this shows me all of that materialized in a single view. All right, go What is everything, you know, in this year, or, you know, it's a quote skyjack so you can get as fancy as you like, and what what I will say this like this search, edit I view it's a VS code thing, not an engine thing, but it's Because the engine, if you follow dingemans method of putting stuff in hierarchies, it makes us search things super powerful, because now you can glob and search within. Yeah, the big dates. You can, for example, if you think back to a programming example, in Python, you can search, you know, under Python, everything in Python that has a gotcha tag, or everything in programming languages, that was hard. And that is something that you get for free with the hierarchy. This is nicely structured, being able to just search everything within that.
161
+
162
+ 21:38
163
+ So what's really fascinating about this for me to watch, is that the name that you get, which is the hierarchy with with dots as separators on the mainframe, that's actually how hierarchical folder structures are achieved. Yeah,
164
+
165
+ 22:01
166
+ that exact naming convention.
167
+
168
+ 22:04
169
+ Nice. I haven't had the pleasure of using many mainframes in the days.
170
+
171
+ 22:09
172
+ Yeah, so that was that one harks back, like decades for me. Okay.
173
+
174
+ 22:14
175
+ Um, so I have an unrelated question, what is the tool you're using? That's echoing the keystrokes. And that's actually VS code. So VS code has something called screencast mode. I'll go ahead, it will show you all the keystrokes.
176
+
177
+ 22:29
178
+ Cool. All right.
179
+
180
+ 22:31
181
+ And that's a nice thing about building engine inside VS code is that, for me, like what was different about attention and what the thing I'm trying to promote is this idea of keeping your notes in a hierarchy and giving you the tools to work with that hierarchy. But then all the other stuff, for example, like being able to work with markdown and supporting multiple panes and having all the other stuff that you need in an editor. It's not really differentiating and you codecademy is a great place for that. And plus you have all the extensions. And VS code has and VS code has like a lot of new features. One of them another one that I really like that I find most people don't know about is you can toggle lines. So if you do option, arrow key, you can move lines up and down. And I find that really nice for prioritizing because I usually like to, you know, keep stuff in this sort of format. And this way, I can easily move stuff down when I'm done. And what's cool is it's not just a single line, you can highlight a whole block and you can move that whole block at a time. But it's just another one little known feature that I find it makes a big quality of life. Yeah.
182
+
183
+ 23:48
184
+ Let's see.
185
+
186
+ 23:51
187
+ Um, this. That's the other thing that you can do. indention is you can paste images. I find that's a question I get a lot specially with Mark And so I use a program called sketch, which lets me take a screenshot of the screen. And then if I do Command Shift C, it puts that image into my clipboard. And then inside address, you can kinda paste image command, which will take whatever is in your clipboard, put it in this path in the vault. And then now you have the picture. And I find that useful because I in markdown paste ads at night, adding media is usually like a problem that people have.
188
+
189
+ 24:32
190
+ Yeah, obsidian handles that pretty well, much the same way. So yeah, that one I haven't had a lot of friction on.
191
+
192
+ 24:41
193
+ And
194
+
195
+ 24:42
196
+ that's really interesting.
197
+
198
+ 24:45
199
+ Yeah, the hierarchy is definitely the thing that I am working upon. And oh, one thing I haven't shown you and this is more of an advanced feature, but you can create schemas for your hierarchies and you can think of femurs is kind of being able to type check. And so I'll show you what I mean by that. So right now I'm creating a lens. And the way I go to schema is I do Command Shift L. And this shows me all the schemas that I have. So it's kind of lookup, but instead of looking for markdown files, I'll explore YAML files. And so your schema, it is just a yamo. And it follows. And what it does, so is it says that, okay, there is a node that is named. And so Lang is the root of your hierarchy. And you can, for example, say that this has children. So for example, Python, it's Ruby. And the only thing you need to specify for the children is that they exist. And now you need to reload the index between schema changes because it hasn't picked up on Live, that's going to change later. But now, if I go into my lookup, if I type in Lang, for example, you'll notice it's actually a little book to it. And the little book over here means that hey, Lang is part of the schema. And if I go down, I can see that Oh, like there's a little book next to Python. That's part of the schema. If you look at JavaScript, because I created
200
+
201
+ 26:31
202
+ it. It's not in the schema, if you look at Java, this little question mark, because it's not in the schema. And the reason you might want to do this is for example, like as I'm building my hierarchy, oh, one thing is you don't have to like enumerate everything. So this a namespace property where you can say this is a namespace. And so now, this is essentially saying that this is going to match now Not start the globbing pattern. The scheme is just based off this simple globbing pattern
203
+
204
+ 27:06
205
+ that would pick up if it existed.
206
+
207
+ 27:08
208
+ Yeah. And so now if I go to Java, this little book to it, because that's in a sec, okay, I recognize it. Now, the interesting part here is now for my children, for example, if I say data,
209
+
210
+ 27:21
211
+ so data structures,
212
+
213
+ 27:24
214
+ and you know, and data, let's say that as their children, like, spring, I have a lot of different autocompletes. So that Well, sometimes,
215
+
216
+ 27:38
217
+ yeah, no, I know how that works. I get that a lot. Yeah.
218
+
219
+ 27:43
220
+ So let's say that I crave
221
+
222
+ 27:46
223
+ that. And so this schema of the way that the globbing patterns work is the children will inherit the parents as a prefix. So this will match Lang dot star dot data. And then string will match Lang dot star dot data watchman. But the schema is also hierarchal. And so now, if I reload my index, if I go to lang.db, dot away, for example, there's a book, because it's part of my schema. But if I look into your data, that Boolean does nothing, because it's not part of my schema. And schemas are really lightweight. It's just that yamo and we don't stop you from creating things outside of your schema, we just show you a question mark. But it's nice. For example, if you're building a programming language hierarchy, and just like sometimes use Google, sometimes use Boolean and you want to keep it consistent, you can document it in your schema. And the engine will also tell you when you're going outside of it, and in the future, we'll add options if you want you to actually enforce it. So you can say like, hey, like, actually don't have any great things that go outside of this. Okay? And that's just because like if my this is how likely entropy builds up and up looks like you name one thing for one fee and then another one for another, and then you have a million different things.
224
+
225
+ 29:07
226
+ Yep, I have, I have several backlinks that I have to go clean up because I did somebody's name or title or something differently in two different places.
227
+
228
+ 29:20
229
+ l and schema strike now. We are also this going to be more features that you can do with schemas. And right now, it does two things. One is it gives you the little book with a little question mark, if you're in a note that matches it. The other thing is you can assign templates to it. So for example, for this thing, I can say that it has a template. And what that means is when I create a note that matches the schema, automatically apply this template to it. And so the idea of this template is going to be the name of another note. And so for example, if I just do a Lang, template, M and M Then I can say this is something inflige. And it's a note template. And the reason you have this this in the future will have different types of templates, you can make templates from snippets, or other sources. And now if I reload my index, and let's create a screen for something I don't have fishing for so let's say Lang dot java data archwing. And oh, something else that schemas that you do is it autocompletes so like, even though again, string haven't been created, it shows you Hey, this matches the dang schema. According to that schema, you happen assumptions.
230
+
231
+ 30:40
232
+ Nice. So if I type in train,
233
+
234
+ 30:46
235
+ it shows you how demos will always break your hearts.
236
+
237
+ 30:52
238
+ Of course,
239
+
240
+ 30:54
241
+ that's me.
242
+
243
+ 30:57
244
+ delete this. So Command Shift D is to do Return note.
245
+
246
+ 31:03
247
+ And
248
+
249
+ 31:06
250
+ let's try this again. I might have to reload the window for it to pick it up. So, let me I just reloaded the window. I'm going to delete this and then try to create it one more time. And then hopefully, but
251
+
252
+ 31:26
253
+ Okay, I'll look into that. But so yeah, yeah, yeah. Okay.
254
+
255
+ 31:37
256
+ And there are other things, but these are essentially like the core parts of dendron. Something else that you can do is you can take your notes, and you can publish it to GitHub. So that's a build command. Right now, because we're in an empty space, you need to run another command to add in some pals, but basically what that when you do build power On a workspace is that it can, it'll generate, it'll turn it into static files that you can publish to GitHub. And it'll have the same template as an engine website. Um, and it's also hierarchical. So you know you the same hierarchy you happen engine you can have on your website, you can choose to publish either everything in your vault, or you can choose which hierarchies you want to publish. And then the other thing is this search bar here. This is actually also path based. So the same lookup mechanism that you use insight engine, you can also use on an engine website.
257
+
258
+ 32:42
259
+ Nice. Yeah.
260
+
261
+ 32:43
262
+ Cool.
263
+
264
+ 32:44
265
+ Yep. Well, thank you. Yeah, no problem.
266
+

Added: vault/dendron.ref.zen.md

Files changed (1) hide show
  1. vault/dendron.ref.zen.md +11 -0
vault/dendron.ref.zen.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 97b90ae4-fedb-4927-bf3f-7f9fc472a939
3
+ title: Zen
4
+ desc: ''
5
+ updated: 1604235708979
6
+ created: 1595341882454
7
+ ---
8
+
9
+ ## On Hierarchies
10
+
11
+ Rigid hierarchies can result in friction to getting thoughts in but having no hierarchy can be problematic in getting notes back out. Dendron tries to walk the line by letting you create links between any two arbitrary notes but also layering on top a flexible hierarchy that lets you prescribe a canonical organization of your notes. See more thoughts on the matter [here](https://www.kevinslin.com/notes/e9c72b4f-adb8-4f15-a6aa-9f9d81538561.html).

Added: vault/dendron.release.2020-07-25.md

Files changed (1) hide show
  1. vault/dendron.release.2020-07-25.md +131 -0
vault/dendron.release.2020-07-25.md ADDED
@@ -0,0 +1,131 @@
1
+ ---
2
+ id: 6aed338c-df05-420d-aa7b-59dfd2214349
3
+ title: Release Notes(version 0.4)
4
+ desc: ''
5
+ updated: 1609990780194
6
+ created: 1595984607502
7
+ date: 2020-07-25
8
+ ---
9
+ Its been an active week of Dendron development. These weekly release notes are to keep you up to date on some of the things we're working on.
10
+
11
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
12
+
13
+ ## Legend
14
+
15
+ - 🚧 experimental
16
+
17
+ ## Features
18
+
19
+ ### New Getting Started Experience ([dd4f50e](https://github.com/dendronhq/dendron/commit/dd4f50eb169e7f9686c4e3fbabca3b2a6c1e1bb7))
20
+
21
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron-quickstart.gif)
22
+
23
+ Dendron has a completely re-done getting started. you can see it by running `> Dendron: Initialize Workspace` in a new workspace and then navigating to `dendron.quickstart`
24
+
25
+ ### 🚧 Graph View for Hierarchies ([129bf4e](https://github.com/dendronhq/dendron/commit/129bf4e4e480dfbff66530725c6db8d2321adc28))
26
+
27
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.graph-view.md)
28
+
29
+ Note that Dendron's graph view lays out your notes according to their hierarchy (vs backlinks).
30
+
31
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph-intro.gif)
32
+
33
+ ### 🚧 Windows Support ([a789ec5](https://github.com/dendronhq/dendron/commit/a789ec5792301103d302739f00b595509128d367))
34
+
35
+ Dendron is now compatible with windows
36
+
37
+ ### Upgrade Settings Command ([c043090](https://github.com/dendronhq/dendron/commit/c0430905d314c6ee870f9bdd45434f53e93a7098))
38
+
39
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#upgrade-settings)
40
+
41
+ Dendron will automatically update your workspace settings during version upgrades to make sure they stay up to date with new features and bundled extensions. If you've modified the settings or want to restore your settings back to their default, you can run this command.
42
+
43
+ ### Reload Index Command ([236b2ac](https://github.com/dendronhq/dendron/commit/236b2ac70812c4df525ff27479802b6e49e0587f))
44
+
45
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#reload-index)
46
+
47
+ Dendron will re-initialize the index. This is currently necessary if you add new entries to a [schema](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.schema.md). Otherwise, Dendron will re-index schemas the next time you reload/open your workspace.
48
+
49
+ ### Open Logs Command ([4f223fc](https://github.com/dendronhq/dendron/commit/4f223fc318fe033471252611c8f41d505dca1055))
50
+
51
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#open-logs)
52
+
53
+ A bunch of you have been submitting issues to our issue tracker. To make the process easier, we now have a command to automatically fetch get the logs for when you submit your next issue.
54
+
55
+ ### Open Link Command ([7f630d1](https://github.com/dendronhq/dendron/commit/7f630d1fb95d5c0d28fc5a83f4cee27bc17d452c))
56
+
57
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.links.md)
58
+
59
+ Be able to open non-markdown files using native apps (eg. use preview to open pdfs on mac).
60
+
61
+ ### Journal Notes ([5e1236f](https://github.com/dendronhq/dendron/commit/5e1236fddbf1e0fddf4c27d1a40e9841cc99974f))
62
+
63
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.special-notes.md#journal-note)
64
+
65
+ A journal note is a self contained note that is meant to track something over time. Examples of journals include recording workout sessions, making meeting notes, and keeping a mood journal.
66
+
67
+ ### Scratch Notes scratch ([71d8433](https://github.com/dendronhq/dendron/commit/71d8433fbd10651ec7fcd13a5f7ee41199a43632))
68
+
69
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.special-notes.md#scratch-note)
70
+
71
+ A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{Y-MM-DD-HH-HHmmss}`.
72
+
73
+ ## Fixes
74
+
75
+ ### Markdown Preview will now Open Local Links ([9a3418](https://github.com/dendronhq/dendron/commit/10a3418f7a633fa9b5294794e1a912cb4ea6c066))
76
+
77
+ Issue were the newest VSCode broken links. This fixes that.
78
+
79
+ ## Enhancements
80
+
81
+ ### Reduce Startup Speed ([4502e49](https://github.com/dendronhq/dendron/commit/4502e49f79d490bb639d2daaf93f841e5b18449d))
82
+
83
+ Use webpack to reduce bundle size and reduce startup speed by factor of 10
84
+
85
+ ### Remove Extra Frontmatter ([e059346](https://github.com/dendronhq/dendron/commit/e0593467fca94a4d29dc9463721a99e67881cfb3))
86
+
87
+ - [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.frontmatter.md)
88
+
89
+ Dendron keeps track of metadata to your notes using frontmatter. There were many fields that we wrote out that didn't need to be written out because Dendron gathers that information during its index phase. Those fields are now no longer written out!
90
+
91
+ ### Initialize Default Workspace with Relative Paths ([790ef50](https://github.com/dendronhq/dendron/commit/790ef503225e5b18a78e3e62e847ba8b2adfd8d0))
92
+
93
+ By not hardcoding the workspace path, it makes it easy to use Dendron between different devices.
94
+
95
+ - change workspaces accepts '~' path ([d6c4f64](https://github.com/dendronhq/dendron/commit/d6c4f64cdfbb9e6b5c44a04320a84756fefcb924))
96
+ - creating journals copies path to clipboard ([a34fc81](https://github.com/dendronhq/dendron/commit/a34fc815454e0e86112d5a507dd0013ec37a0edb))
97
+ - automatic setting upgrades ([ae74675](https://github.com/dendronhq/dendron/commit/ae74675ab05f8b4ff579311850817c434e23ec94))
98
+ - keyboard shortcuts for scratch and journal notes ([076fa18](https://github.com/dendronhq/dendron/commit/076fa18ceb0836736e123d7439af31da00cc2ec2))
99
+
100
+ ### Initialize New Vault With git ([7278b6f](https://github.com/dendronhq/dendron/commit/7278b6fbbf4e175815a0a069c449ad7ef479a77e))
101
+
102
+ Dendron will now initialize a git repository when you run `Initialize Workspace`
103
+
104
+ ### Example Video
105
+
106
+ Dendron now has an example video. You can watch it [here](https://youtu.be/6rwWUalr9Ac).
107
+
108
+ ## Next
109
+
110
+ Some notable items we are working on for the next release. You can see the full roadmap [here](https://github.com/orgs/dendronhq/projects/1). You can join the discussion on upcoming roadmap items in our [#roadmap discord channel](https://discord.gg/HzkFcs).
111
+
112
+ ### Refactor Hierarchies
113
+
114
+ - [issue](https://github.com/dendronhq/dendron/issues/39)
115
+
116
+ Be able to refactor hierarchies and have all file names and links automatically update.
117
+
118
+ ### Publish to Github Pages
119
+
120
+ - [issue](https://github.com/dendronhq/dendron/issues/60)
121
+
122
+ Be able to publish a vault as a github page
123
+
124
+ ## Thank You
125
+
126
+ Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
127
+
128
+ - [Alexis Argyris](https://github.com/alexisargyris)
129
+ - [Jay A. Patel](https://github.com/jayp)
130
+ - [Kiran Pathakota](https://github.com/kpathakota)
131
+

Added: vault/dendron.release.2020-08-02.md

Files changed (1) hide show
  1. vault/dendron.release.2020-08-02.md +175 -0
vault/dendron.release.2020-08-02.md ADDED
@@ -0,0 +1,175 @@
1
+ ---
2
+ id: e32aa1e2-9780-4183-927e-2f46372050aa
3
+ title: Release Notes(version 0.5)
4
+ desc: ''
5
+ updated: 1609990774348
6
+ created: 1596374984386
7
+ date: 2020-08-02
8
+ ---
9
+ With the coming of August, 2020 is officially on the wane. I think many of us are ready for a fresh start. In the meantime, you can prepare for better times by playing with new Dendron features. Happy gardening! 🌱
10
+
11
+ With this release, we are also conducting our first dendron user survey. It's a short survey that should take no more than 3 minutes to fill out and will help inform me on the future growth of Dendron. Your participation is immensely appreciated 🙏
12
+
13
+ <https://forms.gle/PPqe2axvwEmpXj4v5>
14
+
15
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
16
+
17
+ ## Legend
18
+
19
+ - 🚧 experimental feature
20
+
21
+ ## Commands
22
+
23
+ Dendron has a series of built-in commands. They are all prefixed with `Dendron:` and can be accessed through the [command prompt](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#command-bar).
24
+
25
+ ### Add Doctor Command
26
+
27
+ ([d4fa71c](https://github.com/dendronhq/dendron/commit/d4fa71cd839782587d47a3ba1b0f7e89742e7ffe)) ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#doctor))
28
+
29
+ This makes sure your workspace is up to date. It will execute the following actions:
30
+
31
+ - add ids and titles to the frontmatter of all notes that are missing it
32
+ - setup a `docs` folder if it doesn't exist. Required if you want to [[publish|dendron.topic.publishing]] your notes
33
+
34
+ <a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f">
35
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif">
36
+ </a>
37
+
38
+ ### Add ShowHelp Command
39
+
40
+ ([ecf3c68](https://github.com/dendronhq/dendron/commit/ecf3c6822848834d9a00e373d1c59b6628e7f4df))([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#show-help))
41
+
42
+ Dendron will open your current browser to the [[quickstart|dendron.quickstart]] page.
43
+
44
+ <a href="https://www.loom.com/share/b81ce02f30b84d79b92584f339184a00">
45
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/b81ce02f30b84d79b92584f339184a00-with-play.gif">
46
+ </a>
47
+
48
+ ## Pods
49
+
50
+ Pods are the mechanisms Dendron uses to import and export notes. Dendron has a different pod depending on where you are getting and publishing your data to.
51
+
52
+ ### 🚧 Support Publishing Notes
53
+
54
+ ([e063732](https://github.com/dendronhq/dendron/commit/e063732d1ff082dd8520a479926e7ceb1b0893ab)) ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html))
55
+
56
+ Dendron lets you publish the contents of your vault, either in its entirety or only a subset. Notes are published under the [dendron-jekyll theme](https://github.com/dendronhq/dendron-jekyll).
57
+
58
+ ### Features
59
+
60
+ #### Nested Hierarchies
61
+
62
+ dendron-Jekyll supports the same nested hierarchies as your notes and allows you to navigate via the sidebar.
63
+
64
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-hierarchy.gif" />
65
+
66
+ #### Lookup
67
+
68
+ If you'd rather not click, dendron-Jekyll also supports path-based lookup.
69
+
70
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-lookup.gif" />
71
+
72
+ #### Permanent Ids
73
+
74
+ Every page is published using its unique ID which means that URLs will never change, even if the filenames do.
75
+
76
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-ids.jpg" />
77
+
78
+ #### Free hosting, custom domain names and SSL Certs
79
+
80
+ If you have a free GitHub account, then you can host your Dendron notes for free using [github pages](https://pages.github.com/)
81
+
82
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-domain.jpg" />
83
+
84
+ #### Jekyll Liquid Tags and Variables
85
+
86
+ - NOTE: this will only be "compiled" in the published site but won't be rendered in the regular markdown
87
+
88
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-liquid.gif" />
89
+
90
+ #### Selective Publication
91
+
92
+ You can choose to publish your whole vault or a single domain within your vault.
93
+
94
+ - NOTE: It is not currently possible to publish multiple domains. If you would like this feature, you can vote for it [here](https://github.com/dendronhq/dendron/issues/64).
95
+
96
+ ### Setup initial workspace to be ready for publishing
97
+
98
+ ([e1242b4](https://github.com/dendronhq/dendron/commit/e1242b494cc91b3284053b54dccecc4e4686ab7d))
99
+
100
+ All workspaces created from Dendron `0.5` onwards will have all the necessary configuration pre-loaded for publishing.
101
+
102
+ ## Schemas
103
+
104
+ Think of schemas as an **optional type system** for your notes. They describe the hierarchy of your data and are themselves, represented as a hierarchy.
105
+
106
+ ### Enable lookup for Schemas
107
+
108
+ ([19b4677](https://github.com/dendronhq/dendron/commit/19b46770fe6a842831692563de96ff4a823df871)) ([docs](https://www.dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#schemas))
109
+
110
+ The process for finding schemas using Dendron is the same as that for finding notes. One lookup to rule them all.
111
+
112
+ Find Schema
113
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
114
+
115
+ Create Schema
116
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-create.gif)
117
+
118
+ Delete Schema
119
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-delete.gif)
120
+
121
+ ### Schema Templates
122
+
123
+ ([0205d66](https://github.com/dendronhq/dendron/commit/0205d66fc4538361322ffeabb3e532f0d541b775)) ([docs](https://www.dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#schema-templates))
124
+
125
+ Schema templates let you specify a pre-defined template that will automatically be applied to all notes that match the template. You can see a video of how this works below.
126
+
127
+ This is extremely useful whenever you want to re-use the outline of a note. Examples include daily journals, weekly shopping lists, and weekly reviews.
128
+
129
+ <a href="https://www.loom.com/share/481b7ab051394c1caa383383bd265755">
130
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/481b7ab051394c1caa383383bd265755-with-play.gif">
131
+ </a>
132
+
133
+ ### Simpler Schema Syntax
134
+
135
+ ([d53ddb](https://github.com/dendronhq/dendron/commit/d53ddb73bfacc3f769db88cfd4f482a706dcb6dd))
136
+
137
+ Schema syntax has been simplified. Before we had an extra `data` field to namespace the `namespace` field. We flattened all schema attributes to make the syntax more elegant. Note that the old styled `data` syntax is still supported but we recommend moving to the new syntax as `data` will be deprecated in a few releases.
138
+
139
+ ## Fixes
140
+
141
+ Bugfixes for this release
142
+
143
+ - Fix issue with Journal Names on Windows ([d0bfe7f](https://github.com/dendronhq/dendron/commit/d0bfe7fb0288e8610fc4b177ee85697a8ebc3efe))
144
+ - Stub nodes should keep parents when deleted ([f32f291](https://github.com/dendronhq/dendron/commit/f32f291bc7a1ddd6c542483730e2db74b400dafa))
145
+ - Issue with Urls in published site ([0ac8e75](https://github.com/dendronhq/dendron/commit/0ac8e75c95a9c4760e12bb301fc5b66b011ef0fb))
146
+
147
+ ## Enhancements
148
+
149
+ - CI/CD testing ([d6ce68c](https://github.com/dendronhq/dendron/commit/d6ce68c720d7e8c96d7f4bb6ab390c1bd52c5218))
150
+ - Dendron now has continuous integration tests for all pushes. ![](https://travis-ci.com/dendronhq/dendron.svg?branch=master)
151
+ - Tests run on mac, linux and windows which means moving forward, there should be fewer OS (aka Windows) related issues
152
+ - Update [quickstart docs](http://localhost:4000/notes/e86ac3ab-dbe1-47a1-bcd7-9df0d0490b40.html) to showcase new features ([aec0fe0](https://github.com/dendronhq/dendron/commit/aec0fe0939239d84f5b7ebd9ebae57a09bcdae43))
153
+
154
+ ## Next
155
+
156
+ A teaser of some items we are working on for the next release. You can see the full roadmap [here](https://github.com/orgs/dendronhq/projects/1). To join the discussion on upcoming roadmap items, check out the [#roadmap](https://discord.gg/HzkFcs) channel on Discord.
157
+
158
+ ### Refactor Hierarchies
159
+
160
+ - [issue](https://github.com/dendronhq/dendron/issues/39)
161
+
162
+ Be able to refactor hierarchies and have all file names and links automatically update. This was supposed to go out in this week's release but there are just a few items left that need to
163
+
164
+ ### More Templates and Examples
165
+
166
+ Many of you have asked for examples of how to best use Dendron. We will be publishing a list of such demos on [Dendron](https://dendron.so)
167
+
168
+ ## Thank You
169
+
170
+ Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
171
+
172
+ - [Alexis Argyris](https://github.com/alexisargyris)
173
+ - [Gustav](https://github.com/Whil-)
174
+ - [Jochen Burkhard](https://github.com/herop)
175
+

Added: vault/dendron.release.2020-08-09.md

Files changed (1) hide show
  1. vault/dendron.release.2020-08-09.md +100 -0
vault/dendron.release.2020-08-09.md ADDED
@@ -0,0 +1,100 @@
1
+ ---
2
+ id: 075e9806-0367-40a2-8154-2e84d5a020e2
3
+ title: Release Notes(version 0.6)
4
+ desc: ''
5
+ updated: 1609990768070
6
+ created: 1596374871110
7
+ date: 2020-08-09
8
+ ---
9
+ Another week, another minor release. The much asked for `Rename Note` command is here, as well as a bunch of enhancements to notes and schemas. Enjoy 🌱
10
+
11
+ This release is also a reminder to fill out the [Dendron user survey](https://forms.gle/PPqe2axvwEmpXj4v5) if you haven't done so 🙏. This is a super short 3min survey that will help me plan the future growth of Dendron.
12
+
13
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
14
+
15
+ ## Commands
16
+
17
+ ### Add Rename Note Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#rename-note))
18
+
19
+ Do you have regrets? While there are some things that you can't take back, misnaming a note should never be one of them. Dendron now lets you rename files and will update all links in all files that link to it!
20
+
21
+ ![rename](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
22
+
23
+ ### Add Copy Note Link Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#copy-note-link))
24
+
25
+ School's out so it's okay to copy notes. Use this to get the wiki-link (with title) of the current open note.
26
+
27
+ ![copy note link](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
28
+
29
+ ### Enhancements
30
+
31
+ - Show feedback on copy note link
32
+
33
+ ### Fixes
34
+
35
+ - Issue with renamed notes not being indexed
36
+ - Issue where `doctor` doesn't backfill newly created notes'
37
+
38
+ ## Notes
39
+
40
+ ### Flexible Configuration for Notes ([docs](https://www.dendron.so/notes/5c213aa6-e4ba-49e8-85c5-1bdcb33ce202.html#configuration))
41
+
42
+ Notes are now as flexible as your yoga teacher. You can now customize every aspect of your `Journal` and `Scratch` notes - how they are added, their time format and even what they're called
43
+
44
+ ### Add Built in Snippets ([docs](https://www.dendron.so/notes/9eca1992-7540-4d9d-97fb-328b27748b2c.html))
45
+
46
+ All the one-liners and bad jokes that you have saved for that special someone? Type them out faster than ever with built-in snippets. This updates the default settings to allow tab-based snippet completion and also initialize new vaults with some default snippets.
47
+
48
+ ![snippets](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tab-autocomplete.gif)
49
+
50
+ ### Enhancements
51
+
52
+ - Copy on Create: Journal and Scratch notes will automatically copy their links to the clipboard after creation
53
+
54
+ ### Fixes
55
+
56
+ - Scratch note title note being set properly
57
+ - Not all notes indexed in sparse vaults: There was an issue where certain notes without a full hierarchy would not be indexed by Dendron. That issue has now been eliminated.
58
+ - Notes created via link not being indexed properly: Issue where sometimes new notes created using link navigation wasn't being indexed.
59
+
60
+ ## Pods
61
+
62
+ ### Custom Blogging Layout ([docs](https://www.dendron.so/notes/4c0ef322-3006-405c-9a66-3134dd9649a5.html#blogging))
63
+
64
+ Sometimes you have something you just need to shout out from the rooftops. Because its likely people think that you are a crazy person if you did this, Dendron now has dedicated blogging layouts so you can blog instead!
65
+
66
+ ### Fixes
67
+
68
+ - Issue with buildpod logging
69
+
70
+ ## Schemas
71
+
72
+ ### Apply Schema Description to New Notes ([docs](https://www.dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#desc))
73
+
74
+ Schemas now automatically apply their description to newly created notes that match said schema. Because life is too short to annotate all your notes all the time.
75
+
76
+ ### Enhancements
77
+
78
+ - Remove data field from new schemas: Schema notes only show you fields that are required on creation.
79
+
80
+ ## Workspace
81
+
82
+ ### Enhancements
83
+
84
+ - Update index when notes are deleted outside of dendron: We know that sometimes, it can't be helped and you'll need to work with your notes outside of Dendron. If that work is deleting notes, Dendron will now keep track of it and remove it from its lookup index as well!
85
+
86
+ ## Other
87
+
88
+ ### Make Dendron available on [Open VSX Registry](https://open-vsx.org/) ([docs](https://dendron.so/notes/9134f160-31a6-4ab0-a640-1fce466f9526.html#open-vsx))
89
+
90
+ Maybe you just don't like Microsoft. Maybe you want to see other people. Whatever the reason, Dendron is now available on all VSCode compatible editors like [VSCodium](https://vscodium.com/) and [Gitpod](https://www.gitpod.io/).
91
+
92
+ ## Thank You
93
+
94
+ Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
95
+
96
+ - [Josh Finken](https://github.com/jfinken)
97
+ - [denisdifazio](https://github.com/denisdifazio)
98
+ - Annegrim
99
+ - [Chris Na](https://github.com/buxel)
100
+

Added: vault/dendron.release.2020-08-16.md

Files changed (1) hide show
  1. vault/dendron.release.2020-08-16.md +125 -0
vault/dendron.release.2020-08-16.md ADDED
@@ -0,0 +1,125 @@
1
+ ---
2
+ id: 075e9806-0367-40a2-8154-2e84d5a020e5
3
+ title: Release Notes(version 0.7)
4
+ desc: ''
5
+ updated: 1609990760541
6
+ created: 1596374871110
7
+ date: 2020-08-16
8
+ ---
9
+ This is one of our biggest releases yet! Support for r**efactoring hierarchies** and **note references** (think Roam's block references) are the highlight of this week's work. Enjoy responsibly 🌱
10
+
11
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
12
+
13
+ ## Commands
14
+
15
+ ### Add Show Preview Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#showpreview))
16
+
17
+ Dendron now has a new command and shortcut to preview your notes.
18
+
19
+ ### Add Copy Ref Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#copy-note-ref))
20
+
21
+ When one introduces note refs, one must also introduce a command to easily copy note refs.
22
+
23
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
24
+
25
+ ### Add Archive Hierarchy Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#archive-hierarchy))
26
+
27
+ Wouldn't it be nice to have a magic wand to make all your problems go away? While we're working on that, you can use the `Archive Hierarchy Command` to hide hierarchies that you no longer use.
28
+
29
+ <a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
30
+
31
+ ### Add Refactor Hierarchy Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#refactor-hierarchy))
32
+
33
+ Do you want to change the past? Us to. And now you can (when it comes to hierarchies). Instead of living with the consequences of bad past decisions (when it comes to hierarchies), you can now change it!
34
+
35
+ <a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85">
36
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
37
+
38
+ ### Enhancements
39
+
40
+ - Rename note will close old note and open the new note
41
+ - Refactor hierarchy will warn you when overwriting files
42
+
43
+ ### Fixes
44
+
45
+ - Allow empty replacements when refactoring
46
+ - Issue where refactor would miss some links
47
+ - Issue with rename notes missing some links
48
+
49
+ ## Lookup
50
+
51
+ ### Fixes
52
+
53
+ - Issue where new note won't be created if a stub
54
+ - Lookup will exit early on certain inputs
55
+
56
+ ## Markdown
57
+
58
+ ### Support for note references ([docs](https://www.dendron.so/notes/f1af56bb-db27-47ae-8406-61a98de6c78c.html))
59
+
60
+ Were you roam'ing for a note-taking tool that lets you embed notes and sections within notes into other notes? Well, look no further because Dendron note references are here!
61
+
62
+ Link to an entire note!
63
+
64
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
65
+
66
+ Or just a section!
67
+
68
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block.gif)
69
+
70
+ Or a range!
71
+
72
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block-range.gif)
73
+
74
+ ### Enhancements
75
+
76
+ - Update markdown css
77
+
78
+ ## Notes
79
+
80
+ ### Enhancements
81
+
82
+ - Add 'childofdomainnamespace' to note add behaviour
83
+
84
+ ## Other
85
+
86
+ ## Pods
87
+
88
+ ### Publish Multiple Hierarchies within a Vault ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#selective-publication))
89
+
90
+ You can now publish 0, one, or N number of hierarchies within a vault. We're working on negative and complex numbers of hierarchies for future releases.
91
+
92
+ ### Ability to not Publish Select Lines ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#exclude-line-from-publication))
93
+
94
+ Unlike what Mark Zuckerberg might want you to believe, people weren't meant to share EVERYTHING with EVERYONE. Use this to keep private lines private!
95
+
96
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
97
+
98
+ ### Fixes
99
+
100
+ - Building sites without assets directory throws error
101
+ - Bad title for naked wiki links
102
+
103
+ ## Schemas
104
+
105
+ ### Fixes
106
+
107
+ - Issue with schemas that have same ids
108
+
109
+ ## Workspace
110
+
111
+ ### Enhancements
112
+
113
+ - Initialize empty workspace
114
+
115
+ ### Fixes
116
+
117
+ - Remove obsolete info messages
118
+
119
+ ## Thank You
120
+
121
+ Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
122
+
123
+ - [j-steinbach](https://github.com/j-steinbach)
124
+ - [A Howard](https://github.com/runlevelrobot)
125
+

Added: vault/dendron.release.2020-08-23.md

Files changed (1) hide show
  1. vault/dendron.release.2020-08-23.md +184 -0
vault/dendron.release.2020-08-23.md ADDED
@@ -0,0 +1,184 @@
1
+ ---
2
+ id: 075e9806-0367-40a2-8154-2e84d5a1110
3
+ title: Release Notes(version 0.8)
4
+ desc: ''
5
+ updated: 1609990753899
6
+ created: 1596374871110
7
+ date: 2020-08-23
8
+ ---
9
+ Schemas and pods were the focus of this week's efforts.
10
+
11
+ Schemas are now both more powerful and re-usable with a custom `pattern` attribute as well as the ability to `import` existing schemas. As a bonus, you can also visualize your schemas using the `Show Schema Graph` command!
12
+
13
+ On the Pod site, we've made the process of publishing a pod more flexible with per hierarchical configuration options, a unified config syntax and automatic reloading of your config on every publish.
14
+
15
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
16
+
17
+ ## Bundled extensions
18
+
19
+ ### Add ShowSchema Command ([docs](http://dendron.so/notes/587e6d62-3c5b-49b0-aedc-02f62f0448e6.html#dendron-show-schema-graph))
20
+
21
+ You can now view your schemas using the same graph visualization as you do your notes!
22
+
23
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graphs.show-schema.gif)
24
+
25
+ ### Enhancements
26
+
27
+ - Dendron: reload graphs will reload both schema and note graphs
28
+ - Dendron: reload graphs will reload both schema and note graphs
29
+ - Dendron schema graph will show schemas by their title. if not set, revert to id.
30
+
31
+ ## Markdown
32
+
33
+ ### Enhancements
34
+
35
+ - Markdown parsing can now be up to 300% faster publishing a site
36
+
37
+ ## Notes
38
+
39
+ ### Create Daily Journal Note Command ([docs](http://dendron.so/notes/5c213aa6-e4ba-49e8-85c5-1bdcb33ce202.html#daily-journal))
40
+
41
+ The daily journal helps you keep a journal for each day of the year. By default, it will create the journal under `daily.{date}` though this is configurable by setting the `dendron.dailyJournalDomain`.
42
+
43
+ You can create a daily journal using `> Dendron: Create Daily Journal Note` or `CMD+SHIFT+I` shortcut.
44
+
45
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
46
+
47
+ ## Pods
48
+
49
+ ### Support different defaults on a per hierarchy basis when publishing ([docs](http://dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#config))
50
+
51
+ You can now set different publishing defaults for each hierarchy (as well as general defaults for your entire vault.)
52
+
53
+ As an example, below is the config for [my website](https://kevinslin.com). It publishes everything under the `home` and `blog` hierarchies but will only publish notes under `books` if `published: true` is set on the frontmatter.
54
+
55
+ - dendron.yml
56
+
57
+ ```yml
58
+ site:
59
+ siteHierarchies: [home, blog, books]
60
+ siteRootDir: docs
61
+ config:
62
+ books:
63
+ publishByDefault: false
64
+ ```
65
+
66
+ ### Implement new website config syntax ([docs](http://dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#properties))
67
+
68
+ New config syntax unifies a bunch of different configuration options and renames others to more sensible names.
69
+
70
+ ### Enhancements
71
+
72
+ - Auto migrate old-style site config to new style site config
73
+ - Always read config before publishing. no more reloading the workspace after updating dendron.yml!
74
+ - Update site config on dendron starter template
75
+ - Use rsync to copy assets when building pods
76
+
77
+ ### Fixes
78
+
79
+ - Use regular copy command if rsync not installed
80
+ - Links not being converted to ids when publishing
81
+
82
+ ## Schemas
83
+
84
+ ### Support schema import ([docs](http://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#imports-optional-str))
85
+
86
+ It's now possible to import schemas! This means you can now create composable schemas from re-usable pieces.
87
+
88
+ Example:
89
+
90
+ - foo.schema. yml
91
+
92
+ ```yml
93
+ version: 1
94
+ imports:
95
+ - bar
96
+ schemas:
97
+ - id: foo
98
+ parent: root
99
+ children:
100
+ - bar.bar # notice that we prefix the id bar with the filename
101
+ ```
102
+
103
+ - bar.schema.yml
104
+
105
+ ```yml
106
+ version: 1
107
+ schemas:
108
+ - id: bar
109
+ parent: root
110
+ children:
111
+ - one
112
+ - id: one
113
+ ```
114
+
115
+ The above would match the following files
116
+
117
+ ```
118
+ foo.bar # match
119
+ foo.bar.one #match
120
+ ```
121
+
122
+ ### Support match by pattern ([docs](http://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#pattern))
123
+
124
+ You can now explicitly specify a glob pattern for any level of your schema. If not set, defaults to the schema `id`.
125
+
126
+ The following is an example of a schema for `journal` hierarchy.
127
+
128
+ ```yml
129
+ schemas:
130
+ - id: journal
131
+ title: journal
132
+ desc: ""
133
+ parent: root
134
+ children:
135
+ - year
136
+ - id: year
137
+ title: year
138
+ pattern: "[0-2][0-9][0-9][0-9]"
139
+ children:
140
+ - month
141
+ - id: month
142
+ title: month
143
+ pattern: "[0-9][0-9]"
144
+ children:
145
+ - day
146
+ - id: day
147
+ title: day
148
+ pattern: "[0-9][0-9]"
149
+ namespace: true
150
+ ```
151
+
152
+ This will match the following queries
153
+
154
+ ```
155
+ # journal
156
+ # journal.2020
157
+ # journal.2020.09
158
+ # journal.2020.09.12
159
+ # journal.2020.09.12.foo.md
160
+ ```
161
+
162
+ ### Enhancements
163
+
164
+ - Set schema title to id if not set
165
+ - Better error message on bad schema
166
+
167
+ ### Fixes
168
+
169
+ - Autocomplete correctly on imported schema
170
+
171
+ ## Workspace
172
+
173
+ ### Fixes
174
+
175
+ - A misconfigured POSIX path causes dendron to not load on windows
176
+
177
+ ## Thank You
178
+
179
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues and contributed fixes to this release.
180
+
181
+ - [Devashish](https://github.com/ric03uec)
182
+ - [Howard](https://github.com/runlevelrobot)
183
+ - [komoda102](https://github.com/komoda102)
184
+

Added: vault/dendron.release.2020-08-30.md

Files changed (1) hide show
  1. vault/dendron.release.2020-08-30.md +126 -0
vault/dendron.release.2020-08-30.md ADDED
@@ -0,0 +1,126 @@
1
+ ---
2
+ id: 1a79e2a1-c906-4ed4-a528-15bd34c4e649
3
+ title: Release Notes(version 0.9)
4
+ desc: ''
5
+ updated: 1609990746697
6
+ created: 1596374871110
7
+ date: 2020-08-30
8
+ ---
9
+ This week's focus was on improving the initial Dendron startup experience as well as the overall usability. To that end, we introduced our own tree view, overhauled the getting started experience and created a cheatsheet of all commands (with GIFs of course).
10
+
11
+ We also took time to fix bugs and improve performance across Dendron's core features (eg. Lookup, Markdown Preview, etc).
12
+
13
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
14
+
15
+ ## Engine
16
+
17
+ ### Enhancements
18
+
19
+ - Add check to make sure that lookup will throw an error if overwriting an existing file
20
+
21
+ ### Fixes
22
+
23
+ - Sometimes lookup will not return all results on startup
24
+ - Edge case where 'create new' was shown even when note exists
25
+ - Having a naked date in frontmatter could cause lookup to fail
26
+
27
+ ## Hierarchies
28
+
29
+ ### Add Go Up Hierarchy command ([docs](http://localhost:4000/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#go-up-hierarchy))
30
+
31
+ Go up to the closest non-stub parent of the currently open note.
32
+
33
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
34
+
35
+ ## Markdown
36
+
37
+ ### Fixes
38
+
39
+ - Preview command would fail to load preview
40
+
41
+ ## Pods
42
+
43
+ ### Enhancements
44
+
45
+ - Throw error on badly formed links
46
+
47
+ ## Workbench
48
+
49
+ ### Add Dendron tree view ([docs](https://www.dendron.so/notes/f7ebd4aa-8ba7-4bc5-bd00-a1efc5315f07.html#dendron-tree-view))
50
+
51
+ The Dendron Tree View lets you view your hierarchal notes as a traditional folder hierarchy. It has the following capabilities
52
+
53
+ ```
54
+ - click to open note
55
+ - show indicators for `stub` and `schema` notes
56
+ - show title using tooltip
57
+ - realtime update when you create/delete notes
58
+ - toggle all functionality
59
+ - reveal currently open text document
60
+ ```
61
+
62
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.gif)
63
+
64
+ ### Show cheatsheet of all commands ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#showhelp))
65
+
66
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
67
+
68
+ ### Near Instantaneous Lookup 🚀🚀🚀
69
+
70
+ Lookup will complete &lt;100ms even as you scale to thousands of notes.
71
+
72
+ ### Enhancements
73
+
74
+ - Don't ignore focus out on lookup
75
+ - Tree view focus on active editor
76
+ - Show collapse all in tree view
77
+ - Treeview tooltip reflect note title
78
+ - Refresh tree view on note deletion
79
+ - Add sort to tree view
80
+ - Keyboard shortcuts don't require editor focus
81
+ - Update default theme to [github light](https://marketplace.visualstudio.com/items?itemname=github.github-vscode-theme)
82
+ - Loading indicator when workspace is first starting
83
+ - Always initialize first workspace with walkthrough
84
+ - Show create new option in schema lookup
85
+ - Better first workspace experience
86
+ - Bundle dendron markdown preview with dendron on installation
87
+ - New welcome screen on first initialization
88
+ - Better lookup results when at root of vault
89
+
90
+ ### Fixes
91
+
92
+ - Remove stub indicator from lookup after note creation
93
+ - Copy note commands will sometimes fail on windows
94
+ - Copy note link could sometimes fail
95
+ - Add no active item picks back to lookup
96
+ - Misleading loading message
97
+
98
+ ## Community
99
+
100
+ ### Dendrologist
101
+
102
+ We introduced our first Dendrologist this week. [Kiran Pathakoda](https://github.com/kpathakota) has been one of the first to adopt Dendron as his primary note taking platform and will be helping out with the development of Dendron.
103
+
104
+ In practice, this means Kiran will be hanging around the discord, help triage issues, and help me put together a more comprehensive public roadmap for the project!
105
+
106
+ If you're interested in being more involved with the development of Dendron (and this doesn't have to involve coding), feel free to ping me on Discord or by email at [kevin@dendron.so](mailto:kevin@dendron.so).
107
+
108
+ There are a bunch of really exciting things that will be coming out over the next couple of weeks and we will need all the dendrologist we can get :)
109
+
110
+ ### New Channels
111
+
112
+ - \#dev: discuss all things related to Dendron development
113
+ - \#schemas: share and discuss schemas
114
+ - \#workflows: how do you take notes?
115
+
116
+ ## Thank You
117
+
118
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues and contributed fixes to this release.
119
+
120
+ - [Jochen Burkhard](https://github.com/herop)
121
+ - [Janne Ojanaho](https://github.com/jojanaho)
122
+ - [Chris Na](https://github.com/buxel)
123
+ - [Daria Vasyukova](https://github.com/gereleth)
124
+ - [Denis Di Fazio](https://github.com/denisdifazio)
125
+ - [nixsee](https://github.com/nixsee)
126
+

Added: vault/dendron.release.2020-09-06.md

Files changed (1) hide show
  1. vault/dendron.release.2020-09-06.md +169 -0
vault/dendron.release.2020-09-06.md ADDED
@@ -0,0 +1,169 @@
1
+ ---
2
+ id: 08b2e6ea-bd3e-4f4b-b2b9-676a7b743a65
3
+ title: Release Notes(version 0.10)
4
+ desc: ''
5
+ updated: 1609990740754
6
+ created: 1596374871110
7
+ date: 2020-09-06
8
+ ---
9
+ Dendron turns 0.10 today 🌲. To mark this milestone, the pre-amble for this release will be a tad longer (and more sentimental) than usual.
10
+
11
+ This week's release focuses on publication and exports. Dendron sites now come with [one click collaboration support](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#edit-on-github), [note references](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#note-references), and [hierarchy hints](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#nav-based-hierarchy-hints). If publishing online isn't your jam, you'll be happy to know that you can now [export your notes](https://www.dendron.so/notes/66727a39-d0a7-449b-a10d-f6c438185d7f.html#json-pod) to any format you desire (as long as that format is JSON 😅 - more formats coming soon).
12
+
13
+ It's now been almost two months since Dendron first went into preview. Since launch, we've passed over a thousand downloads and closed over [100 issues](https://github.com/dendronhq/dendron/issues?q=is%3Aissue+is%3Aclosed) worth of features, enhancements, and bug fixes.
14
+
15
+ In that time, we've built an awesome community of Dendrites on Discord now numbering in the triple digits. I feel beyond grateful to everyone that has given Dendron a try in these early days 🌱 and become a part of our budding community.
16
+
17
+ Speaking of community, I would like to recognize two new **Dendrologist** - [Fayçal](https://github.com/d3vr) (@bsqrd#9701 ) and [Janne Ojanaho](https://github.com/jojanaho) (@jojanaho#3766 ) 👨‍🌾👩‍🌾
18
+
19
+ Dendrologists are active members of the Dendron community that will be helping me shape our roadmap, answer questions, and collect feedback from all of you. If you've spent any time in our discord, you've probably already had chats with one or both of the folks I just mentioned.
20
+
21
+ That's all for last week's release. Stay tuned for some big announcements later this week :)
22
+
23
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
24
+
25
+ ## Development
26
+
27
+ ### Fixes
28
+
29
+ - Bad import causes dendron to not compile in case-sensitive file systems
30
+
31
+ ## Engine
32
+
33
+ ### Fixes
34
+
35
+ - Fix bad sibling traversal cases
36
+ - Issue with mixed case file names
37
+
38
+ ## Markdown
39
+
40
+ ### Support offset with note refs ([[docs|dendron.topic.refs]])
41
+
42
+ A note reference offset is a way to skip a number of lines when using a note reference. The syntax is `,{number}`. Below is an example of using a note reference offset to offset an initial heading, skipping the actual header when doing the embedding.
43
+
44
+ - NOTE: currently, note reference offsets are limited to the first anchor inside a block reference. They must also be a positive value
45
+
46
+ <a href="https://www.loom.com/share/31cb62916586453f8475f94ba68b74a1"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/31cb62916586453f8475f94ba68b74a1-with-play.gif"> </a>
47
+
48
+ ### Enhancements
49
+
50
+ - Note refs will not be resolved when inside an inline code span or a fenced code block
51
+
52
+ ### Fixes
53
+
54
+ - Fix issue with preview checkbox not updating markdown
55
+ - Fix issue with backslash causing in certain markdown blocks
56
+
57
+ ## Pods
58
+
59
+ ### Support note references when Publishing Notes ([[docs|dendron.topic.publishing]])
60
+
61
+ Dendron has [[note references|dendron.topic.refs]] that let you inline either the whole note or parts of a note into another note. Publishing via Dendron will also publish note references as part of the process.
62
+
63
+ <a href="https://www.loom.com/share/8eb01f6c3196415c8aadc4992805a176"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/8eb01f6c3196415c8aadc4992805a176-with-play.gif"> </a>
64
+
65
+ ### Add Export Pod Command ([[docs|dendron.topic.commands]])
66
+
67
+ Export notes to an external data source. Currently, only JSON is supported.
68
+
69
+ <a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
70
+
71
+ ### JSON export pod ([[docs|dendron.topic.pod]])
72
+
73
+ Export your Dendron notes to a JSON file
74
+
75
+ ### Enhancements
76
+
77
+ - Don't convert note refs inside code blocks
78
+
79
+ ## Publishing
80
+
81
+ ### Nav Based Hierarchy Hints ([[docs|dendron.topic.publishing]])
82
+
83
+ You can see at a glance which notes have children and explore them from the nav without refreshing the page.
84
+
85
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron.jekyll.gif)
86
+
87
+ ### Edit on Github ([[docs|dendron.topic.publishing]])
88
+
89
+ Every page can accept one-click contributions as long as the contributor has a GitHub account.
90
+
91
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll.edit.jpg)
92
+
93
+ Example of making a contribution to Dendron.
94
+
95
+ <a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
96
+
97
+ ## Workbench
98
+
99
+ ### Add Goto Next/Prev Sibling command ([[docs|dendron.topic.commands]])
100
+
101
+ - shortcuts:
102
+ - mac: `cmd+shift+right`
103
+ - key: `ctrl+shift+right`
104
+ - when: `editorFocus`
105
+
106
+ Go to the next/previous sibling
107
+
108
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
109
+
110
+ ### Add Go Down command ([[docs|dendron.topic.commands]])
111
+
112
+ - shortcuts:
113
+ - mac: `cmd+shift+down`
114
+ - key: `ctrl+shift+down`
115
+ - when: `editorFocus`
116
+
117
+ Go down the hierarchy
118
+
119
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
120
+
121
+ ### Enhancements
122
+
123
+ - Don't focus on the tree view if it's not visible
124
+ - Create stub notes from the tree view
125
+
126
+ ### Fixes
127
+
128
+ - Don't update color theme on upgrade
129
+ - Upgrade settings sometimes override existing settings
130
+ - Issues with note refs not displaying in some cases
131
+ - Rename note will not update dendron tree view
132
+
133
+ ## Thank You
134
+
135
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
136
+
137
+ - [Fayçal](https://github.com/d3vr)
138
+ - [Stylyzed Tag CSS](https://www.dendron.so/notes/692fa114-f798-467f-a0b9-3cccc327aa6f.html#stylized-tags-using-custom-css)
139
+ - [Dendron Tag Search Extension](https://marketplace.visualstudio.com/items?itemName=d3vr.tag-search)
140
+
141
+ - [Ed](https://github.com/ens100)
142
+ - [Update Dendron docs](https://github.com/dendronhq/dendron-template/commit/28c86d5afba0f7ca21e15e749e67464cce2397e2)
143
+ - [Making an absolutely awesome getting started with Dendron video](https://www.youtube.com/watch?v=BRLLZ9IEh10)
144
+ - Writing up a step by step publishing guide for Dendron
145
+
146
+ - [Daria Vasyukova](https://github.com/gereleth)
147
+ - Being a professional Dendron bug catcher
148
+ - <https://github.com/dendronhq/dendron/issues/162>
149
+ - <https://github.com/dendronhq/dendron/issues/161>
150
+ - <https://github.com/dendronhq/dendron/issues/143>
151
+
152
+ - [mebu83](https://github.com/mebu83)
153
+ - [Issue with blof refs not resolving](https://github.com/dendronhq/dendron/issues/146)
154
+
155
+ - [eflinfoki](https://github.com/eflinfoki)
156
+ - [Update dendron troubleshooting guide](https://github.com/dendronhq/dendron-template/pull/6)
157
+
158
+ - [Janne Ojanaho](https://github.com/jojanaho)
159
+ - [Updating Dendron FAQ](https://github.com/dendronhq/dendron-template/commit/9252d12f21dc21fca0a2e2bf36da9edc84202227)
160
+
161
+ - Tom
162
+ - [Providing a transcript of Dendron's onboarding video](https://www.dendron.so/#onboarding)
163
+
164
+ - [Rhaynes](https://github.com/rhaynes74)
165
+ - [Issue with markdown preview not rendering math elements correctly](https://github.com/dendronhq/dendron/issues/156)
166
+
167
+ - [Howard](https://github.com/runlevelrobot)
168
+ - [Issue with tree view making sidebar visible when not wanted](https://github.com/dendronhq/dendron/issues/150)
169
+

Added: vault/dendron.release.2020-09-13.md

Files changed (1) hide show
  1. vault/dendron.release.2020-09-13.md +145 -0
vault/dendron.release.2020-09-13.md ADDED
@@ -0,0 +1,145 @@
1
+ ---
2
+ id: 50071eda-fc46-4aca-ba6c-9d53db00d068
3
+ title: Release Notes(version 0.11)
4
+ desc: ''
5
+ updated: 1610062114528
6
+ created: 1596374871110
7
+ date: '2020-09-13'
8
+ ---
9
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/comic.1.png)
10
+
11
+ - My wife, Ilana Lin, drew a comic for this week's release. Follow her on [instagram](https://www.instagram.com/accidentalflower/) and she might draw more comics for Dendron 😇
12
+
13
+ ## Summary
14
+
15
+ This week's release comes with improved references as well as better tooling around pods and snippets.
16
+
17
+ **Dendron's pretty refs** help you identify when content is embedded from elsewhere and provide links back to the source.
18
+
19
+ ((ref:[[dendron.topic.refs]]# references,1:# *))
20
+
21
+ The **Dendron CLI** lets you access a subset of Dendron's functionality inside the terminal, including the ability to import/export your notes.
22
+
23
+ We also released the **Dendron Snippet Maker**, a standalone extension that comes bundled with Dendron which helps you create [[snippets|dendron.topic.snippets]] from the current selected text.
24
+
25
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
26
+
27
+ ## CLI
28
+
29
+ ### Release Dendron CLI
30
+
31
+ Dendron now has a its own CLI that you can run standalone from the Dendron plugin.
32
+
33
+ ((ref:[[dendron.topic.cli]]#install))
34
+
35
+ ### Enhancements
36
+
37
+ - Run export pod using cli
38
+ - Run import pod using cli
39
+ - Run backfill using cli
40
+
41
+ ### Fixes
42
+
43
+ - Import using cli not initialized in certain cases
44
+
45
+ ## Notes
46
+
47
+ ### New note from selection cmd
48
+
49
+ Create new note from a selection
50
+
51
+ ## Pods
52
+
53
+ ### Add configure pod command
54
+
55
+ ((ref:[[dendron.topic.commands]]#configure pod,1:#*))
56
+
57
+ ### Enhancements
58
+
59
+ - Use consistent interface for import/export
60
+ - Additional additional options on export
61
+
62
+
63
+ ### Fixes
64
+
65
+ - Deal with `.` when importing directories
66
+
67
+ ## Publishing
68
+
69
+ ### Published sites use pretty refs
70
+
71
+ ((ref:[[dendron.topic.publishing.configuration]]#useprettyrefs,1:#*))
72
+
73
+ ### Support noindex option
74
+
75
+ ((ref:[[dendron.topic.publishing.configuration]]#noindex,1:#*))
76
+
77
+ ### Enhancements
78
+
79
+ - Add config to specify pretty refs
80
+
81
+ ### Fixes
82
+
83
+ - Update bad links
84
+ - Fix ref display on published site
85
+
86
+ ## Refs
87
+
88
+ ### Support wildcard refs
89
+
90
+ ((ref:[[dendron.topic.refs]]#wildcard header reference,1:#*))
91
+
92
+ ### Enhancements
93
+
94
+ - Create ref with anchor if selected
95
+ - Render refs in container
96
+
97
+ ### Fixes
98
+
99
+ - Bad ref resolution
100
+
101
+ ## Workbench
102
+
103
+ ### Dendron Snippet Maker
104
+
105
+ ((ref:[[dendron.pro.dendron-snippet-maker]]#dendron snippet maker,1))
106
+
107
+ ### Enhancements
108
+
109
+ - Friendlier default settings
110
+
111
+ ## Community Announcements
112
+
113
+ ### Planters
114
+
115
+ A bunch of our fellow Dendronites have published notes using Dendron. You can check it at the [[showcase|dendron.community.showcase]].
116
+
117
+ We've also created a new role -> @Planter :man_farmer::woman_farmer: , to recognize folks who have published using Dendron.
118
+
119
+ If you have a site you would like to showcase, please ping Kevin ([kevin@dendron.so](mailto:kevin@dendron.so)) or edit the showcase page directly and adding your site :)
120
+
121
+ ## Thank You
122
+
123
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
124
+
125
+ - [Fayçal](https://github.com/d3vr)
126
+ - giving us the dendron emoji
127
+
128
+ - [Ed](https://github.com/ens100)
129
+ - updating various Dendron docs
130
+ - raise copy issue when publishing a dendron vault
131
+ - contribute new default completion settings for Dendron
132
+
133
+ - [Daria Vasyukova](https://github.com/gereleth)
134
+ - updating docs
135
+
136
+ - [Handuo](https://github.com/zhanghanduo)
137
+ - suggest [better block refs](https://github.com/dendronhq/dendron/issues/174)
138
+ - suggest block refs autocomplete
139
+
140
+ - [Mr. Lightbulb](https://github.com/JackQAQ-byte)
141
+ - [latex doesn't render when publishing](https://github.com/dendronhq/dendron/issues/195)
142
+
143
+ - [Tom](https://github.com/peanutputter)
144
+ - [Image Markdown fails with spaces and caps in name of file](https://github.com/dendronhq/dendron/issues/200)
145
+

Added: vault/dendron.release.2020-09-20.md

Files changed (1) hide show
  1. vault/dendron.release.2020-09-20.md +125 -0
vault/dendron.release.2020-09-20.md ADDED
@@ -0,0 +1,125 @@
1
+ ---
2
+ id: 8e59e25f-808c-42f1-a82a-e9ce4fd8edd8
3
+ title: Release Notes(version 0.12)
4
+ desc: ''
5
+ updated: 1609990694687
6
+ created: 1596374871110
7
+ date: 2020-09-20
8
+ ---
9
+ Dendron 0.12 is here 🌱
10
+
11
+ This week's focus was on publishing. We have a bunch of enhancements and additions to the publishing workflows. We also introduced the [[seeds library|dendron.topic.seeds]], a way of you to remix existing content with Dendron. You can see an example of this [here](http://aws.dendron.so/)
12
+
13
+ This release also brings some changes to Dendron's update cycle.
14
+ You might have noticed that Dendron updates rather aggressively 🚀🚀🚀
15
+
16
+ Our current release cycle is a patch update every day and a minor release every week.
17
+ Moving forward, we will be doing patch updates every few days and a minor release every two weeks.
18
+
19
+ The move to this new release cycle is a reflection that Dendron is growing rapidly and starting to mature.
20
+
21
+ We will be working on some major changes in October to stabilize the core feature set and make them easier to use. We will also be shifting our underlying architecture from a VSCode plugin to the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) which will result in a richer feature set and the ability for Dendron to be more easily integrated into additional editors.
22
+
23
+ As part of this update, we've put out the first version of the [Dendron principles](https://dendron.so//notes/7fcebd7d-6411-4c9d-8baf-65629dc018a1.html) which reflects our design philosophies and the direction we are taking Dendron.
24
+
25
+ This is a work in progress so feel free to make suggestions and comments in the discord.
26
+
27
+ I've mentioned this before but we will also be releasing our formal roadmap by the end of the month. This roadmap will cover all major projects we plan on doing in 2020.
28
+
29
+ We are looking to come out of preview by the end of October and do a formal 1.0 release before the end of the year.
30
+
31
+ I want to take this moment to again thank everyone for being part of our journey to build a better tool for managing knowledge 👨‍🌾👩‍🌾
32
+
33
+ I believe we're are planting something special here and am excited to see us grow 🌱
34
+
35
+ These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
36
+
37
+ * * *
38
+
39
+ ## Cli
40
+
41
+ ### Support for seeds
42
+
43
+ ((ref:[[dendron.topic.seeds]]#seeds 🚧,1:#*))
44
+
45
+ ### Enhancements
46
+
47
+ - Standardize on core cli flags across all commands
48
+ - More options when planting seeds
49
+
50
+ ## Hierarchies
51
+
52
+ ### Fixes
53
+
54
+ - Rename when stub is present
55
+
56
+ ## Lookup
57
+
58
+ ### Lookup new notes with Selection
59
+
60
+ ((ref:[[dendron.topic.lookup]]#creating notes with a selection,1:#*))
61
+
62
+ ### Enhancements
63
+
64
+ - Lookup can extract highlighted text
65
+
66
+ ## Pods
67
+
68
+ ### Implement Json import pod
69
+
70
+ ((ref:[[dendron.topic.pod.builtin.json]]))
71
+
72
+ ### Enhancements
73
+
74
+ - All filepaths can be set relative to the workspace root
75
+ - Json pod can import filenames as links
76
+ - Standardize interface for import/export pod commands
77
+
78
+ ### Fixes
79
+
80
+ - Handle stub notes correctly on import
81
+
82
+ ## Publishing
83
+
84
+ ### Publish command
85
+
86
+ ((ref:[[dendron.topic.commands]]#publish,1:#*))
87
+
88
+ ### Copy note url command
89
+
90
+ ((ref:[[dendron.topic.commands]]#copy note url,1:#*))
91
+
92
+ ### Enhancements
93
+
94
+ - Support relative path for all file paths
95
+ - Set custom path for publishing repo
96
+ - Keyboard shortcuts for copy note url cmd
97
+ - Be able to pass in custom args to commands
98
+ - Support incremental page building
99
+
100
+ ### Fixes
101
+
102
+ - Copy url truncates `//`
103
+
104
+ ## Thank You
105
+
106
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
107
+
108
+ - [Denis Sikuler](https://github.com/gamtiq)
109
+ - update docs
110
+
111
+ - [agichim](https://github.com/agichim)
112
+ - update docs
113
+
114
+ - [Daria Vasyukova](https://github.com/gereleth)
115
+ - bug with copy note url
116
+
117
+ - [Jack](https://github.com/JackQAQ-byte)
118
+ - issue with images on published sites
119
+
120
+ - [Tom](https://github.com/peanutputter)
121
+ - [issue with image paths](https://github.com/dendronhq/dendron/issues/200)
122
+
123
+ - [Janne Ojanaho](https://github.com/jojanaho)
124
+ - [writeup on files vs folders](https://github.com/dendronhq/dendron/issues/210)
125
+

Added: vault/dendron.release.2020-10-19.md

Files changed (1) hide show
  1. vault/dendron.release.2020-10-19.md +67 -0
vault/dendron.release.2020-10-19.md ADDED
@@ -0,0 +1,67 @@
1
+ ---
2
+ id: 1b1aef8e-c9d5-42de-b850-d1b1467cf88b
3
+ title: Release Notes(version 0.13)
4
+ desc: ''
5
+ updated: 1609990585321
6
+ created: 1603123991664
7
+ ---
8
+ Dendron 0.13 is here 🌱
9
+
10
+ It's been a few weeks since the last minor release. This iteration was mostly spent on our server migration as well as a series of quality of life improvements across Dendron's core features. You can find the details of all this in the highlights below.
11
+
12
+ ## Highlights
13
+
14
+ - move to the final phase of the [[server migration|dendron.roadmap.project.n.2020.server-migration]]
15
+ - Dendron server mode is now at feature parity with existing functionality
16
+ - the server migration is a complete re-write of Dendron's internal to go from a client to client (local) server model
17
+ - this is pre-requisite for a bunch of upcoming features like [[multi vault support|dendron.roadmap.project.n.2020.multi-vault]], rich graphical interfaces, and realtime graph updates
18
+ - server mode will be the default for all workspaces going forward
19
+ - existing workspaces will be transparently migrated over after next week
20
+ - order of magnitude speed improvements (server mode only)
21
+ - initializing large vaults
22
+ - updating links through `Rename` and `Refactor` operations
23
+ - better note references
24
+ - note references can now be nested
25
+ - a reference to a header can be made by selecting any part of the header before running `Copy Note Ref`
26
+ - better timestamps (server mode only)
27
+ - the `updated` timestamp on notes now updates on every save
28
+ - timestamp will now print a human friendly label
29
+ - improved publishing
30
+ - dendron sites now support latex
31
+ - dendron will generate a bad link report for all links that do not resolve when publishing
32
+ - bad links will now resolve to a custom 404 link
33
+ - you can define a custom site repository that will be used by publishing commands
34
+ - consolidated lookup
35
+ - creating journal notes and scratch notes are now part of the `Lookup Command` instead of being separate commands (the old keyboard shortcuts still work - they now map to lookup commands with custom arguments)
36
+ - lookup now accepts arguments that can be passed in via custom keyboard shortcuts
37
+ - you can control the creation of special notes as well as note selection behavior from lookup
38
+
39
+ ## Seeds
40
+
41
+ Aside from features, we've also launched two [[seeds|dendron.topic.seeds]]. Seeds are **open source dendron sites** that **consolidate reference material** about a **particular vertical**. Content from the catalogues is derived from existing open source content as well as manual user input. Your 🙏 is welcomed and encouraged.
42
+
43
+ ((ref:[[dendron.community.showcase]]#open pkm catalogue,1:#*))
44
+ ((ref:[[dendron.community.showcase]]#open aws catalogue,1:#*))
45
+
46
+ ## Sustainability
47
+
48
+ Finally, a bunch of you have asked if you can support Dendron financially. The answer is coming at the end of the month! Dendron will be coming out of **preview** in November, at which point we will launch our **Environmentalist Plan** 🌲. This is a monthly subscription to support the development of Dendron. **Environmentalist** will get a special badge on Discord, priority email/discord access to the development team, and stickers! More details on this soon.
49
+
50
+ ## Thank You
51
+
52
+ Last and most of all, a big to the following gardeners that brought up issues, contributions, and fixes to this release.
53
+
54
+ - [Britt](https://github.com/bs)
55
+ - [silent log errors](https://github.com/dendronhq/dendron/issues/277)
56
+ - various doc updates
57
+ - [onwijsbegeerte](https://github.com/onwijsbegeerte)
58
+ - [bad export pod placeholder text](https://github.com/dendronhq/dendron/issues/270)
59
+ - [agichim ](https://github.com/agichim)
60
+ - [checkbox in preview doesn't render correctly](https://github.com/dendronhq/dendron/issues/269)
61
+ - [Emaro](https://github.com/Emaro)
62
+ - [treeview empty in certain cases](https://github.com/dendronhq/dendron/issues/263)
63
+ - [robothor](https://github.com/robothor)
64
+ - [issue refactoring with mixed case filenames](https://github.com/dendronhq/dendron/issues/250)
65
+
66
+ ((ref:[[dendron.release.changelog]]#0.12.11,1))
67
+

Added: vault/dendron.release.2020-11-01.md

Files changed (1) hide show
  1. vault/dendron.release.2020-11-01.md +80 -0
vault/dendron.release.2020-11-01.md ADDED
@@ -0,0 +1,80 @@
1
+ ---
2
+ id: 98ad9b6b-53f3-4883-939e-e14055f2cac7
3
+ title: Release Notes(version 0.14)
4
+ desc: ''
5
+ updated: 1609990585322
6
+ created: 1604241475533
7
+ ---
8
+ Dendron 0.14 is here 🌱
9
+
10
+ At 14, Dendron might not yet be old enough to vote (if you are old enough and in the USA, please do that next week) but it is coming out of **preview** 🥳
11
+
12
+ Concretely, this means a few things:
13
+
14
+ 1. Dendron is announcing our **[Environmentalist](https://accounts.dendron.so/account/subscribe)** plan, a 100% optional monthly subscription for users who like to support us financially
15
+ 2. Dendron will now commit to a regular release cycle. New releases will go out at the beginning of every week. **Environmentalist** will get access to early builds and features every few days.
16
+ 3. Dendron will have a deprecation policy for all non-experimental (🚧) features. Any potentially breaking changes will first be deprecated and users will have at least a week's notice before a breaking change is made.
17
+ 4. Dendron is dropping the preview label
18
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/preview.png)
19
+
20
+ As part of getting out of preview, we are launching on [Product Hunt](https://www.producthunt.com/posts/dendron), a popular online catalogue for new products. If Dendron has been helpful in your life, we would appreciate it 🙏 if you could leave us some comments there. This will help new people discover our community!
21
+
22
+ <a href="https://www.producthunt.com/posts/dendron?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-dendron" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=273037&theme=light" alt="Dendron - A better way to know | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
23
+
24
+ ### Highlights
25
+
26
+ - complete [[server migration|dendron.roadmap.project.n.2020.server-migration]] for all users
27
+ - create [[snapshots|dendron.topic.capabilities.snapshot]] of your vault and restore them back to a specific point in time
28
+ - introduce [Environmentalist Plans](https://accounts.dendron.so/account/subscribe) for folks that want to support Dendron financially
29
+ - add [publishing](https://dendron.so/notes/66727a39-d0a7-449b-a10d-f6c438185d7f.html#publish) capability to pods (with ability to publish to json and regular markdown)
30
+ - support creating generated [table of contents](https://dendron.so/notes/ffa6a4ba-5eda-48c7-add5-8e2333ba27b4.html#toc) when publishing
31
+ - realtime schema validation when saving
32
+ - numerous enhancements
33
+ - numerous bug fixes
34
+ - better handling of errors and failures
35
+
36
+ ### Community
37
+
38
+ - new roles
39
+
40
+ - introduce the **Environmentalist** role, created for folks that are keeping Dendron sustainable through a monthly contribution
41
+ - Britt Selvitelle (@britt#3020)
42
+ - Tom Diaz (@TomD#7339)
43
+ - Kiran Pathakota (@kpats#8761)
44
+ - Cristian Caratti (@ccaratti#2465)
45
+ - Ken Sonoda (@ksoda#9504)
46
+ - Adam Howard (@A Howard#8010)
47
+ - Ladd Hoffmab (@Bassmann#5300)
48
+ - Fayçal MITIDJI (@bsqrd#9701)
49
+ - Tyler Nieman (@tsnieman#6157)
50
+ - Ilana Lin (@ilana#7242)
51
+ - Luke Roslanowski (@lukecarrier#2081)
52
+ - Huw Millar
53
+ - Martin Stemplinger
54
+
55
+ - introducing the **Horticulturalist** role, created for folks who have contributed to the Dendron code base
56
+ - Britt Selvitelle (@britt#3020)
57
+ - Luke Roslanowski (@lukecarrier#2081)
58
+ - we now have a new [[community|dendron.community]] section on our website that highlights the work and roles of our members
59
+
60
+ ### House Keeping
61
+
62
+ - `dendron.noServerMode` setting has been removed
63
+ - Dendron docs has been re-organized to be less overwhelming (if you have an links bookmarked, they will still all work because of Dendron's [permanent links](https://dendron.so/notes/5fcb8564-7209-4a80-9bb8-025bc8eb489b.html#permanent-ids))
64
+
65
+ ### Upcoming
66
+
67
+ - Dendron office hours: this will be additional slots you can book outside of the initial onboarding to go over specific workflows. More details and schedule to follow in next week's release!
68
+ - Dendron [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
69
+ - Better migration workflows from other tools into Dendron
70
+
71
+ ### Thanks
72
+
73
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
74
+
75
+ - [Britt](https://github.com/bs)
76
+
77
+ ### Changelog
78
+
79
+ ((ref:[[dendron.release.changelog]]#13.6:#0.12.11))
80
+

Added: vault/dendron.release.2020-11-08.md

Files changed (1) hide show
  1. vault/dendron.release.2020-11-08.md +49 -0
vault/dendron.release.2020-11-08.md ADDED
@@ -0,0 +1,49 @@
1
+ ---
2
+ id: 63ea2e72-4eba-406c-9f4c-7300fa0b8935
3
+ title: Release Notes(version 0.15)
4
+ desc: ''
5
+ updated: 1609990585327
6
+ created: 1604882865662
7
+ ---
8
+ Dendron 0.15 is here 🌱
9
+
10
+ ### Highlights
11
+
12
+ - [lookup multi-select](https://dendron.so/notes/ad270a7d-2aed-4273-8319-eb6536e38b29.html#multiselect)
13
+ - [copy links](https://dendron.so/notes/ad270a7d-2aed-4273-8319-eb6536e38b29.html#copywikilink) from lookup
14
+ - better [obsidian markdown import](https://dendron.so/notes/13c4a608-0a32-4c62-9c7e-2b7f9f2d18bf.html#links)
15
+ - multiple bug fixes
16
+ - better code hygiene after removing ~8000 lines of code
17
+
18
+ ### Community
19
+
20
+ I'm thrilled to announce our latest **Dendrologist**! Meet Luke (@lukecarrier#2081) 👨‍🌾
21
+
22
+ > Hey 👋 I’m Luke and I’m going to be picking up some development work. Ask me about the markdown editing experience, publishing and integrating external tools.
23
+
24
+ ((ref:[[dendron.community.roles]]#dendrologist,1:#*))
25
+
26
+ ### In the Works
27
+
28
+ - Still working through the details of official Dendron office hours. Expect a message later this week!
29
+ - Dendron [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
30
+ - [November Milestones](https://github.com/dendronhq/dendron/milestone/5)
31
+
32
+ ### Thanks
33
+
34
+ - environmentalist 👨‍🌾👩‍🌾
35
+ - Michael Pfammatter
36
+ - Matthew Long
37
+ - Geert Theys
38
+ - Huw Millar
39
+ - [gnomesoup](https://github.com/gnomesoup)
40
+ - [bad create daily journal note signature](https://github.com/dendronhq/dendron/issues/333)
41
+ - [seedublancaster](https://github.com/seedublancaster)
42
+ - [fix typos](https://github.com/dendronhq/dendron/pull/323)
43
+ - [tfer](https://github.com/tfer)
44
+ - [update docs on stub](https://github.com/dendronhq/dendron-template/pull/33/files)
45
+
46
+ ## Changelog
47
+
48
+ ((ref:[[dendron.release.changelog]]#changelog,1:#13.6))
49
+

Added: vault/dendron.release.2020-11-15.md

Files changed (1) hide show
  1. vault/dendron.release.2020-11-15.md +56 -0
vault/dendron.release.2020-11-15.md ADDED
@@ -0,0 +1,56 @@
1
+ ---
2
+ id: 11c9f170-3864-4406-9631-053241553b35
3
+ title: Release Notes(version 0.16)
4
+ desc: ''
5
+ updated: 1610062031478
6
+ created: 1605459905174
7
+ ---
8
+ Dendron 0.16 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - even faster lookup 🚀 🚀 🚀
13
+ - we made a bunch of optimizations to lookup so it is now many times faster
14
+ - wildcard note ref links
15
+ - you can now add a `*` operator to the end of your note references to grab everything from a level of hierarchy
16
+ - experimental multi-vault support 🚧
17
+ - you can now add any number of vaults to your workspace and query everything using lookup
18
+ - a slimmed down getting started experience
19
+ - instead of 100+ notes, you now get 1 note (with links to 100+ notes)
20
+ - lots of bug fixes 🔨🐛
21
+
22
+ ### Community
23
+
24
+ - Dendron Office Hours
25
+ - We are kicking off our live bi-monthly office hours this week! The first session will be held this Wednesday (11/18) at 12PM PST on [Twitch](https://www.twitch.tv/dendronhq)
26
+ - Office hours are a channel to get answers to all the questions you're not afraid to ask during a live stream
27
+ - For people that can't make the time, we will have the session recorded and are taking questions ahead of time in the #office-hours channel on discord
28
+ - link to the original [discord announcement](https://discord.com/channels/717965437182410783/737323300967022732/776567468356927568)
29
+
30
+ ### In the Works
31
+
32
+ - a better **up to date** public roadmap
33
+ - bringing multi-vault to feature parity with all existing Dendron functionality
34
+ - a better publishing experience
35
+
36
+ ### Thanks
37
+
38
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
39
+
40
+ - [Luke Carrier](https://github.com/LukeCarrier)
41
+ - [New getting started experience](https://github.com/dendronhq/dendron-template/pull/1)
42
+ - [Chris Pickett](https://github.com/bunchesofdonald)
43
+ - [fix typos in initial vault notes](https://github.com/dendronhq/dendron/pull/335)
44
+ - [Jan Reitz](https://github.com/janreitz)
45
+ - [fix yml block in docs](https://github.com/dendronhq/dendron-template/pull/36)
46
+ - [Konrad Jamrozik](https://github.com/konrad-jamrozik)
47
+ - [bad schema in initial vault notes](https://github.com/dendronhq/dendron/issues/342)
48
+ - [Danny Tran](https://github.com/nabdtran)
49
+ - [fix typos in docs](https://github.com/dendronhq/dendron-site/pull/37)
50
+ - [Bassmann](https://github.com/Bassmann), [Konrad Jamrozik](https://github.com/konrad-jamrozik)
51
+ - [can't create scratch notes issue](https://github.com/dendronhq/dendron/issues/346)
52
+
53
+ ### Changelog
54
+
55
+ ((ref:[[dendron.release.changelog]]#0.15.3:#0.14.2))
56
+

Added: vault/dendron.release.2020-11-22.md

Files changed (1) hide show
  1. vault/dendron.release.2020-11-22.md +70 -0
vault/dendron.release.2020-11-22.md ADDED
@@ -0,0 +1,70 @@
1
+ ---
2
+ id: f09162ec-6b20-4b53-bd5c-68aaa4698ed8
3
+ title: Release Notes(version 0.17)
4
+ desc: ''
5
+ updated: 1609990585314
6
+ created: 1606074212157
7
+ ---
8
+ Dendron 0.17 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - better autocomplete for wiki links
13
+ - autocomplete will now prompt without a trigger, complete on links with aliases and complete faster than ever
14
+ - relative wiki links
15
+ - you can now link to a specific section of a note using the `[[foo#header]]` syntax
16
+ - faster language features 🚀 🚀 🚀
17
+ - going to a link definition, finding link references and other link specific functionality is much faster
18
+ - lots of bug fixes and enhancements
19
+ - bunch of things are better with this release
20
+
21
+ ### Community
22
+
23
+ - Dendron Office Hours
24
+ - We had our first live office hours this week. Thanks to everyone that participated! You can find the recording [here](https://discord.com/channels/717965437182410783/737323300967022732/778798279658962944). A reminder that you can submit questions ahead of time in the #office-hours channel in [discord](https://discord.gg/AE3NRw9). We'll send another survey this week for scheduling the next office hours at the end of the month.
25
+
26
+ ### House Cleaning
27
+
28
+ - Deprecation of `Dendron Markdown Notes`
29
+ - prior to 0.17, Dendron used the aforementioned extension for language features like auto completion and following links
30
+ - with 0.17, all language features is now being handled with Dendron
31
+ - Dendron Markdown Notes is no longer required and can interfere with new definitions
32
+ - You can uninstall Dendron Markdown Notes through the extensions panel inside VSCode
33
+ ![uninstall ](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/etc.install.jpg)
34
+ - Version Number in DendronConfig
35
+ - `dendron.yml` now has an added `version` field. It's automatically set to `0` for all current configurations. we'll be coming out with a new version in the near future to support additional multi-vault features
36
+
37
+ ### In the Works
38
+
39
+ Most of the same items from last week still apply 😅
40
+
41
+ - a better **up to date** public roadmap
42
+ - bringing multi-vault to feature parity with all existing Dendron functionality
43
+ - a better publishing experience
44
+
45
+ ### Thanks
46
+
47
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
48
+
49
+ - [Konrad Jamrozik](https://github.com/konrad-jamrozik)
50
+ - [fix typo](https://github.com/dendronhq/dendron-site/pull/38)
51
+ - [show note graph doesn't prune stubs](https://github.com/dendronhq/dendron/issues/359)
52
+ - [Daniel Zhang](https://github.com/DanielHZhang)
53
+ - [rename note issues](https://github.com/dendronhq/dendron/issues/338)
54
+ - [Tyler Nieman](https://github.com/tsnieman)
55
+ - [Dendron graph title](https://github.com/dendronhq/dendron/issues/358)
56
+ - [LucasD3](https://github.com/LucasD3)
57
+ - [missing welcome note](https://github.com/dendronhq/dendron/issues/361)
58
+ - [Gabriel Horner](https://github.com/cldwalker)
59
+ - [update multi-vault docs](https://github.com/dendronhq/dendron-site/pull/39)
60
+ - [Oli Crask](https://github.com/OxygenLithium)
61
+ - [Stale notes in tree view](https://github.com/dendronhq/dendron/issues/367)
62
+ - [John Young](https://github.com/iterating)
63
+ - [Don't override minimap preferences](https://github.com/dendronhq/dendron/issues/366)
64
+ - [Tim Condit](https://github.com/tcondit)
65
+ - [Fix typos](https://github.com/dendronhq/dendron-site/pull/40)
66
+
67
+ ### Changelog
68
+
69
+ ((ref:[[dendron.release.changelog]]#0.16.3:#0.16.1))
70
+

Added: vault/dendron.release.2020-11-29.md

Files changed (1) hide show
  1. vault/dendron.release.2020-11-29.md +52 -0
vault/dendron.release.2020-11-29.md ADDED
@@ -0,0 +1,52 @@
1
+ ---
2
+ id: a929ff5a-b6c0-417b-a3af-d70af3626aa5
3
+ title: Release Notes (version 0.18)
4
+ desc: ''
5
+ updated: 1609261174120
6
+ created: 1606679635868
7
+ ---
8
+ Dendron 0.18 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - instant link previews
13
+ - peek into links without opening them
14
+ - dendron web ui (for configuration updates)
15
+ - configure dendron using shiny new graphics
16
+ - more multi-vault enhancements
17
+ - support more commands
18
+ - lots of bug fixes
19
+ - because bugs are not a feature
20
+
21
+ ### Community
22
+
23
+ - Dendron Office Hours
24
+ - Our next live office hours will take place this Wednesday (12/02) at 11AM PST on [twitch](https://www.twitch.tv/dendronhq). A reminder that you can submit questions ahead of time in the #office-hours channel in [discord](https://discord.gg/AE3NRw9). We'll send another survey this week for scheduling the next office hours at the end of the month.
25
+
26
+ ### In the Works
27
+
28
+ - bringing multi-vault to feature parity
29
+ - better note references
30
+ - a better publishing experience
31
+
32
+ ### Thanks
33
+
34
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
35
+
36
+ - [Gabriel Horner](https://github.com/cldwalker)
37
+ - [fix out of date jekyll config](https://github.com/dendronhq/dendron/pull/372)
38
+ - [Kiran Pathakoda](https://github.com/kpathakota)
39
+ - [fix build issues](https://github.com/dendronhq/dendron/pull/379)
40
+ - [Ilia Auerbach-Ziogas](https://github.com/iliaaz)
41
+ - [fix typo](https://github.com/dendronhq/dendron-site/pull/43)
42
+ - [ms3056](https://github.com/ms3056)
43
+ - [fix typo](https://github.com/dendronhq/dendron/issues/383)
44
+ - [Christopher Corley](https://github.com/cscorley)
45
+ - [Toggle plugin views using 'when' contexts](https://github.com/dendronhq/dendron/pull/386)
46
+ - [Tyler Nieman](https://github.com/tsnieman)
47
+ - [Dendron Web UI PR](https://github.com/dendronhq/dendron/pull/351)
48
+
49
+ ### Changelog
50
+
51
+ ((ref:[[dendron.release.changelog]]#0.17.2:#0.16.3))
52
+

Added: vault/dendron.release.2020-12-07.md

Files changed (1) hide show
  1. vault/dendron.release.2020-12-07.md +53 -0
vault/dendron.release.2020-12-07.md ADDED
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: 42e90950-38c4-4869-9f3c-ddd84f7ac7eb
3
+ title: Release Notes(version 0.19)
4
+ desc: ''
5
+ updated: 1609990585307
6
+ created: 1607367621793
7
+ ---
8
+ Dendron 0.19 is here 🌱
9
+
10
+ ### Highlights
11
+
12
+ - support for remote vaults
13
+ - natively add vaults published to git to your current workspace
14
+ - support for image hover
15
+ - peek at images without using the preview
16
+ - most commands are now multi-vault enabled
17
+ - yay multi-vault
18
+ - much faster lookup performance for large vaults
19
+ - lots of bug fixes
20
+
21
+ ### Community
22
+
23
+ - @ianjones#3696 and @karlicoss#6608 became the latest `@Planters` to publish using Dendron: <https://dendron.so/notes/3a82c5ff-7945-46ae-8bf9-3b2275fc6642.html>
24
+ - we added 2 new `@Environmentalist`: thank you @fudo#1010 and @mcbishop#3274 for contributing!
25
+ - fun fact: we now have environmentalists in every continent except Antartica 👨‍🌾 👩‍🌾
26
+ - @ianjones#3696 made an awesome series of videos that go over getting started with Dendron: <https://egghead.io/playlists/build-a-personal-knowledge-management-system-with-dendron-b24b>
27
+
28
+ ### In the Works
29
+
30
+ - finish multi-vault feature parity
31
+ - list of non-compatible commands can be found [[here|dendron.topic.multi-vault#known-issues]] (we're almost done)!
32
+ - a better publishing experience
33
+ - better note references
34
+
35
+ ### Thanks
36
+
37
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
38
+
39
+ - [Bassmann](https://github.com/Bassmann)
40
+ - [can't add local vault](https://github.com/dendronhq/dendron/issues/396)
41
+ - [issue creating journal notes in multi-vault](https://github.com/dendronhq/dendron/issues/395)
42
+ - [Franco Barbeite](https://github.com/FrancoB411)
43
+ - [markdown import breaks latex](https://github.com/dendronhq/dendron/issues/389)
44
+ - Kevin
45
+ - errors when running doctor command
46
+ - Mike
47
+ - completion not matching the whole link
48
+ - tree view putting notes under wrong vault
49
+
50
+ ### Changelog
51
+
52
+ ((ref:[[dendron.release.changelog]]#0.18.2:#0.17.2))
53
+

Added: vault/dendron.release.2020-12-14.md

Files changed (1) hide show
  1. vault/dendron.release.2020-12-14.md +59 -0
vault/dendron.release.2020-12-14.md ADDED
@@ -0,0 +1,59 @@
1
+ ---
2
+ id: 44fd6c57-b7f4-47f5-a632-d352d4f4fa7b
3
+ title: Release Notes(version 0.20)
4
+ desc: ''
5
+ updated: 1609990585324
6
+ created: 1607890901199
7
+ ---
8
+ Dendron 0.20 is here 🌱
9
+
10
+ ### Highlights
11
+
12
+ - dendron seed bank
13
+ - a registry of open source vaults that you can add to your workspace
14
+ - refactor for multi-vault
15
+ - one of the last items for multi-vault feature parity is now here
16
+ - select vault on creation
17
+ - option to always pick which vault new notes are created in
18
+ - many enhancements and bugfixes
19
+
20
+ ### Community
21
+
22
+ - @ianjones#3696 and @fudo#1010 boosted the Dendron Server which means we have lots more custom emoji slots we need to fill. Any suggestions welcome :)
23
+ - new planters: @dolearning (Kevin)#3551
24
+ - new bug catchers: @Costa#1636, @niveus#4940, @Buxel#7181
25
+ - new horticulturalist: @dolearning (Kevin)#3551, @ianjones#3696, @bublucious#1002
26
+ - new taxonomist: @dolearning (Kevin)#3551, @fudo#1010
27
+
28
+ You can find a description of all roles [[here|dendron.community.roles]]
29
+
30
+ ### In the Works
31
+
32
+ - finish multi-vault feature parity
33
+ - we're down to our last few features
34
+ - list of non-compatible commands can be found [[here|dendron.topic.multi-vault#known-issues]] (we're really almost done)
35
+ - a better publishing experience
36
+ - better note references
37
+
38
+ ### Thanks
39
+
40
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
41
+
42
+ - Costa
43
+ - issue with image preview links
44
+ - [Kevin Cunningham](https://github.com/doingandlearning)
45
+ - [add search to 11ty template](https://github.com/dendronhq/dendron-11ty/pull/5)
46
+ - [Chris Na](https://github.com/buxel)
47
+ - [issue with Dendron Doctor](https://github.com/dendronhq/dendron/issues/400)
48
+ - Brian Scott
49
+ - issue with nested git repos
50
+ - remote repo doesn't respect name settings
51
+ - [Josh Brainard](https://github.com/brainjos)
52
+ - [note creation not respect title case](https://github.com/dendronhq/dendron/pull/404)
53
+ - [flammehawk](https://github.com/flammehawk)
54
+ - bad link in testimonial docs
55
+
56
+ ### Changelog
57
+
58
+ ((ref:[[dendron.release.changelog]]#0.19.3:#0.18.2))
59
+

Added: vault/dendron.release.2020-12-21.md

Files changed (1) hide show
  1. vault/dendron.release.2020-12-21.md +51 -0
vault/dendron.release.2020-12-21.md ADDED
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: e543ad13-1108-448c-b3a6-9976fd7a65ce
3
+ title: Release Notes(version 0.21)
4
+ desc: ''
5
+ updated: 1609990585326
6
+ created: 1608580995965
7
+ ---
8
+ Dendron 0.21 is here 🌱
9
+
10
+ With 0.21, multi-vault should now be at feature parity with single vault workspaces. Multi-vault specific behavior is documented [[here|dendron.topic.multi-vault]].
11
+
12
+ 0.21 also brings about Dendron's 2nd Generation publishing feature. This is a faster, leaner, and more powerful way to publish your notes using Dendron.
13
+
14
+ There's still some work left to integrate publishing into the Dendron plugin - meanwhile, you can take the new publishing workflow for a spin by following the instructions [[here|dendron.topic.publishing.quickstart]]
15
+
16
+ ### Highlights
17
+
18
+ - publishing v2
19
+ - v2 is over 30x faster (compiling the dendron site takes 6s for 200 pages vs 220s in v1) 🚀🚀🚀
20
+ - v2 supports publishing with multi-vault
21
+ - v2 is all javascript (no more download ruby just to publish)
22
+ - support note references for multi-vault
23
+ - bug fixes and performance improvements
24
+
25
+ ### Community
26
+
27
+ - new bug catchers: @rasmuse#4440 @Contessa#0861 @TokyoMike#2771
28
+ - new environmentalist: @Stephen#8544
29
+
30
+ You can find a description of all roles [[here|dendron.community.roles]]
31
+
32
+ ### In the Works
33
+
34
+ - bring publishing v2 to feature parity
35
+ - better note references
36
+
37
+ ### Thanks
38
+
39
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
40
+
41
+ - [Rasmus Einarsson](https://github.com/rasmuse)
42
+ - [Self referential refactoring issue](https://github.com/dendronhq/dendron/issues/406)
43
+ - [Whitney](https://github.com/whitbur)
44
+ - [Note creation from selected text mangles non-vault files](https://github.com/dendronhq/dendron/issues/410)
45
+ - [Mike](https://github.com/ms3056)
46
+ - [Matching requires unique files for lower nodes](https://github.com/dendronhq/dendron/issues/407)
47
+
48
+ ### Changelog
49
+
50
+ ((ref:[[dendron.release.changelog]]#0.20.2:#0.19.3))
51
+

Added: vault/dendron.release.2020-12-28.md

Files changed (1) hide show
  1. vault/dendron.release.2020-12-28.md +56 -0
vault/dendron.release.2020-12-28.md ADDED
@@ -0,0 +1,56 @@
1
+ ---
2
+ id: e05c751f-7d5c-4fcf-8868-01092813d1dd
3
+ title: Release Notes(version 0.22)
4
+ desc: ''
5
+ updated: 1609990585313
6
+ created: 1609180024902
7
+ ---
8
+ Dendron 0.22 is here 🌱
9
+
10
+ This release focuses on Dendron's [[Publishing v2|dendron.topic.publishing]]. With this release, v2 is functionally at feature parity with our legacy jekyll based publishing (and over 30x faster). You can see the remaining gaps [[here|dendron.topic.publishing.migration#gaps]]. These should be closed by the end of this week.
11
+
12
+ - NOTE: to get the latest publishing changes, make sure to run the following commands in your workspace. See [[here|dendron.topic.publishing.quickstart]] for setup instructions
13
+
14
+ ```
15
+ npm install @dendronhq/dendron-cli@latest
16
+ npm install @dendronhq/dendron-11ty@latest
17
+ ```
18
+
19
+ ### Highlights
20
+
21
+ - dendron v2 publishing functionally at feature parity with legacy publishing
22
+ - we're using it to host [dendron.so](https://dendron.so/) now :)
23
+ - [[github actions based publishing workflow|dendron.topic.publishing.github]]
24
+ - keep a clean git history by having github manage building your website
25
+ - bug fixes and performance improvements
26
+
27
+ ### In the Works
28
+
29
+ - Integrate publishing with plugin
30
+ - Auto generate title based on frontmatter
31
+ - More publishing and preview features
32
+
33
+ ### Thanks
34
+
35
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
36
+
37
+ - first timer (see [[roles here|dendron.community.roles]])
38
+ - bug catchers: @Metalsmf#7744 @Stephen#8544 @muon#1974 @Francobar#1299
39
+ - taxonomist: @eeBaiQuai#1157
40
+ - all contributions
41
+ - Britt Richardson (@Metalsmf#7744)
42
+ - issue building site on diff versions of node
43
+ - [fix typo](https://github.com/dendronhq/dendron-site/pull/50)
44
+ - [flammehawk](https://github.com/flammehawk)
45
+ - [remove colors from dev env](https://github.com/dendronhq/dendron/pull/423)
46
+ - Stephen (@Stephen#8544)
47
+ - issue building 11ty on multiple operating systems
48
+ - Muon (@muon#1974) and [Franco Barbeite](https://github.com/FrancoB411):
49
+ - [issue with math in preview](https://app.zenhub.com/workspaces/dendron-5f06937cfa4f3b001d5673c9/issues/dendronhq/dendron/424)
50
+ - [Newman5](https://github.com/Newman5)
51
+ - [typo in faq](https://github.com/dendronhq/dendron/pull/426)
52
+
53
+ ### Changelog
54
+
55
+ ((ref:[[dendron.release.changelog]]#0.21.2:#0.20.2))
56
+

Added: vault/dendron.release.2021-01-04.md

Files changed (1) hide show
  1. vault/dendron.release.2021-01-04.md +62 -0
vault/dendron.release.2021-01-04.md ADDED
@@ -0,0 +1,62 @@
1
+ ---
2
+ id: e81d2800-83c0-4ba6-8f00-34c3557da43d
3
+ title: Release Notes (version 0.23)
4
+ desc: ''
5
+ updated: 1609787304398
6
+ created: 1609786176221
7
+ ---
8
+ Dendron 0.23.0 has sprouted :seedling:
9
+
10
+ See the upgrade instructions [[here|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
11
+
12
+ ### Highlights
13
+
14
+ - auto-title notes using note frontmatter
15
+ - titles show up in preview and when publishing
16
+ - lots of publishing enhancements
17
+ - support blog like archives, much smaller bundle sizes, auto focused nav and more
18
+ - cli based doctor
19
+ - make sure your notes are healthy for the new year
20
+
21
+ ### In the Works
22
+
23
+ - integrating 11ty publishing with dendron workspace
24
+ - managed publishing
25
+ - better ergonomics around multi-workspace
26
+
27
+ ### Thanks
28
+
29
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
30
+
31
+ - new role assignments:
32
+ - bug catchers: @Oli916#5867 @ric03uec#5826
33
+ - environmentalist: @corey#9677
34
+ - all contributions
35
+ - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
36
+ - doctor doesn't exit after running
37
+ - [Micharris42](https://github.com/micharris42)
38
+ - [Document Display Order in the Dendron Tree View](https://github.com/dendronhq/dendron/issues/440)
39
+ - [Oli Crask](https://github.com/olivercrask) @Oli916#5867
40
+ - [Published extended syntax markdown not rendering](https://github.com/dendronhq/dendron/issues/437)
41
+ - [Dendron publish not authenticating](https://github.com/dendronhq/dendron/issues/436)
42
+ - [Devashish](https://github.com/ric03uec) @ric03uec#5826
43
+ - [publish V2 throws error locally](https://github.com/dendronhq/dendron/issues/434)
44
+ - [Simon J S Liu](https://github.com/wind13) @Simon Liu#7080
45
+ - [Improve the import pod feature for import Hugo/Hexo etc](https://github.com/dendronhq/dendron/issues/432)
46
+ - [BC](https://github.com/generic-user)
47
+ - [Ctrl + hover creates a note, it should only create one on Ctrl + Click #430](https://github.com/dendronhq/dendron/issues/430)
48
+ - [Luke Carrier](https://github.com/LukeCarrier) @lukecarrier#2081
49
+ - tireless work battling windows CI issues
50
+
51
+ ### Version Numbers
52
+
53
+ Version numbers for this week's release
54
+
55
+ - plugin: 0.23.0
56
+ - 11ty: v1.23.0
57
+ - preview: 0.10.17
58
+
59
+ ### Changelog
60
+
61
+ ((ref:[[dendron.release.changelog]]#0.22.2:#0.21.2))
62
+

Added: vault/dendron.release.2021-01-11.md

Files changed (1) hide show
  1. vault/dendron.release.2021-01-11.md +48 -0
vault/dendron.release.2021-01-11.md ADDED
@@ -0,0 +1,48 @@
1
+ ---
2
+ id: d508e0f9-8bbe-43b4-83c1-0ff022b1d4fb
3
+ title: Release Notes (version 0.24)
4
+ desc: ''
5
+ updated: 1610992516921
6
+ created: 1610403349466
7
+ ---
8
+
9
+ Dendron 0.24 has sprouted :seedling:
10
+
11
+ ### Highlights
12
+ - updated note ref syntax ([[docs|dendron.topic.refs]])
13
+ - use `![[foo]]` to create a note ref
14
+ - frontmatter variable substitution ([[docs|dendron.topic.markdown#frontmatter-variable-substitution]])
15
+ - use variables defined in your frontmatter inside your notes!
16
+ - markdown improvements for preview and publishing ([[docs|dendron.topic.markdown#extended-syntax]])
17
+ - bugs and performance related changes
18
+
19
+ ### Breaking Changes
20
+ - update date format for journal and scratch notes to use [Luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html) ([[docs|dendron.topic.config#dendrondefaultjournaldateformat]])
21
+ - this affects you if you updated `dendron.default*DateFormat` to something other than the default
22
+ - we made this change because [moment.js](https://momentjs.com/docs/#/-project-status/), our original date library, is now a legacy project and won't be receiving any new updates
23
+
24
+ ### Community
25
+
26
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
27
+
28
+ - new role assignments
29
+ - grndstt: @grndstt#1420
30
+ - all contributions
31
+ - grndstt: @grndstt#1420
32
+ - issue publishing with subdomain
33
+ - [Mike](https://github.com/ms3056) @TokyoMike#2771
34
+ - [links in preview not rendering correctly](https://github.com/dendronhq/dendron/issues/442)
35
+ - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
36
+ - windows Dendron publishing QA work
37
+
38
+ ### Versions Numbers
39
+ This release comes with the following versions:
40
+ - dendron plugin: 0.24.0
41
+ - dendron markdown preview: 0.10.19
42
+ - dendron cli: 0.24.0
43
+ - dendron 11ty: 1.24.0
44
+
45
+ - dendron plugin and dendron markdown preview will be auto-installed by VSCode
46
+ - See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
47
+
48
+ ![[dendron.release.changelog#0232:#0222]]

Added: vault/dendron.release.2021-01-18.md

Files changed (1) hide show
  1. vault/dendron.release.2021-01-18.md +65 -0
vault/dendron.release.2021-01-18.md ADDED
@@ -0,0 +1,65 @@
1
+ ---
2
+ id: 9293d889-e07f-4a01-b67f-e8aca7c1c7f7
3
+ title: Release Notes (version 0.25)
4
+ desc: ''
5
+ updated: 1614965553884
6
+ created: 1610992021546
7
+ ---
8
+ Dendron 0.25 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - native publication
13
+ - preview and build your notes for publication from within VSCode ([[docs|dendron.topic.commands#site-build]])
14
+ - custom header support
15
+ - include your own headers when publishing ([[docs|dendron.topic.publishing.configuration#customheaderpath-optional]])
16
+ - bunch of bug fixes and enhancements
17
+
18
+ ### Spring Cleaning
19
+
20
+ - [[dendron v1|dendron.topic.publishing]] publishing is now being deprecated
21
+ - all users are encouraged to switch to [[Publishing V2|dendron.topic.publishing]]
22
+ - support until end of January at which point we will be removing v1 related functionality
23
+ - this includes
24
+ - [[Build Pod Command|dendron.topic.commands#build-pod]]
25
+ - [[Publish Command|dendron.topic.commands#publish]]
26
+ - [[buildSite CLI|dendron.topic.cli#buildsite]]
27
+ - [[publishnotes CLI|dendron.topic.cli#publishnotes]]
28
+ - [[dendron.copyNoteUrlRoot|dendron.topic.config#dendroncopynoteurlroot]] deprecated for `siteUrl`
29
+
30
+ ### Community
31
+
32
+ Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
33
+
34
+ - [Luke Carrier](https://github.com/LukeCarrier) @lukecarrier#2081
35
+ - [CI/CD on push](https://github.com/dendronhq/dendron/pull/449)
36
+ - Ryan Randall `#environmentalist`
37
+ - contributing to dendron
38
+ - [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934 `#taxonomist` `#bug-catcher`
39
+ - [[Dendron QA Notes|dendron.dev.testing.notes]]
40
+ - [issue with breadcrumbs](https://github.com/dendronhq/dendron-11ty/issues/9)
41
+ - [Simon Claudius](https://github.com/Simon-Claudius) @Simon-Claudius#7577 `#bug-catcher`
42
+ - [graph view broken](https://github.com/dendronhq/dendron/issues/452)
43
+ - [Micharris42](https://github.com/micharris42)
44
+ - [issue with backslash in preview](https://github.com/dendronhq/dendron/issues/450)
45
+
46
+ You can see an overview of all roles [[here|dendron.community.roles]]
47
+
48
+ ### Version Numbers
49
+
50
+ This release comes with the following versions:
51
+
52
+ - dendron plugin: 0.25
53
+
54
+ - dendron markdown preview: 0.10.19
55
+
56
+ - dendron cli: 0.25
57
+
58
+ - dendron 11ty: 1.25
59
+
60
+ - dendron plugin and dendron markdown preview will be auto-installed by VSCode
61
+
62
+ - See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
63
+
64
+ ![[dendron.release.changelog#0242:#0232]]
65
+

Added: vault/dendron.release.2021-01-25.md

Files changed (1) hide show
  1. vault/dendron.release.2021-01-25.md +48 -0
vault/dendron.release.2021-01-25.md ADDED
@@ -0,0 +1,48 @@
1
+ ---
2
+ id: f5d459b0-01ea-4bd2-bb8b-ed7f7f7a8e0c
3
+ title: Release Notes (version 0.26)
4
+ desc: ''
5
+ updated: 1611617928912
6
+ created: 1611615493246
7
+ ---
8
+ Dendron 0.26 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - use note titles for link names ([[docs|dendron.topic.config#usenotetitleforlink]])
13
+ - mermaid diagram support when publishing ([[docs|dendron.topic.markdown#diagrams]])
14
+ - better dup note handling when publishing from multi-vault ([[docs|dendron.topic.publishing.configuration#passing-multiple-vaults]])
15
+
16
+ ### Community
17
+
18
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
19
+
20
+ - [Handuo](https://github.com/zhanghanduo) @Handuo#0146 +#Bug Catcher
21
+ - error with newly installed workspaces
22
+ - Zenen @zenen#9708
23
+ - issue with md outline
24
+ - [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
25
+ - [Markdown Pod Tests](https://github.com/dendronhq/dendron/pull/458)
26
+ - [Scott Spence](https://github.com/spences10) @spences10#5535 +#Bug Catcher
27
+ - [Windows Clipboard Issue](https://github.com/dendronhq/dendron/issues/465)
28
+ - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
29
+ - [Old title in daily notes](https://github.com/dendronhq/dendron/issues/461)
30
+
31
+ ### Version Number
32
+
33
+ This release comes with the following versions:
34
+
35
+ - dendron plugin: 0.26
36
+
37
+ - dendron markdown preview: 0.10.22
38
+
39
+ - dendron cli: 0.26
40
+
41
+ - dendron 11ty: 1.26
42
+
43
+ - dendron plugin and dendron markdown preview will be auto-installed by VSCode
44
+
45
+ - See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
46
+
47
+ ![[dendron.release.changelog#0253:#0242]]
48
+

Added: vault/dendron.release.2021-02-01.md

Files changed (1) hide show
  1. vault/dendron.release.2021-02-01.md +43 -0
vault/dendron.release.2021-02-01.md ADDED
@@ -0,0 +1,43 @@
1
+ ---
2
+ id: b5db61c8-9d48-449a-b6b4-2750d3be1a6f
3
+ title: Release Notes (version 0.27)
4
+ desc: ''
5
+ updated: 1612208194965
6
+ created: 1612204959344
7
+ ---
8
+ Dendron 0.27 has sprouted 🌱
9
+
10
+ ### Highlights
11
+
12
+ - move notes between vaults using the move note command ([[docs|dendron.topic.commands#move-note]])
13
+ - pretty 403 pages on unpublished pages ([[docs|dendron.topic.publishing.selective-publication#403-page]])
14
+ - lots of bug fixes
15
+
16
+ ### Community
17
+
18
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
19
+ You can see an overview of all roles [[here|dendron.community.roles]]
20
+
21
+ - [Julien Muniak](https://github.com/Darune)
22
+ - [Crash when vscode is run with unsupported LOG_LEVEL](https://github.com/dendronhq/dendron/issues/466)
23
+ - [Stedag](https://github.com/Stedag)
24
+ - [Refactoring results in md auto-correct](https://github.com/dendronhq/dendron/issues/467)
25
+
26
+ ### Version Numbers
27
+
28
+ This release comes with the following versions:
29
+
30
+ - dendron plugin: 0.27
31
+
32
+ - dendron markdown preview: 0.10.22
33
+
34
+ - dendron cli: 0.27
35
+
36
+ - dendron 11ty: 1.26.2
37
+
38
+ - dendron plugin and dendron markdown preview will be auto-installed by VSCode
39
+
40
+ - See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
41
+
42
+ ![[dendron.release.changelog#0261:#0253]]
43
+

Added: vault/dendron.release.2021-02-08.md

Files changed (1) hide show
  1. vault/dendron.release.2021-02-08.md +41 -0
vault/dendron.release.2021-02-08.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: c99c55b0-a709-41fe-a59e-1f1c932346dc
3
+ title: Release Notes (version 0.28)
4
+ desc: ''
5
+ updated: 1612845956396
6
+ created: 1612844876830
7
+ ---
8
+
9
+
10
+ Dendron 0.28 has sprouted 🌱
11
+
12
+ This week is a stability release. We've spent time fixing bugs and improving defaults so your gardens can make it through the winter.
13
+
14
+ ### Highlights
15
+ - better default behavior for multi-vault
16
+ - generate a diagnostics report to quickly fix issues
17
+ - heaps of bug fixes
18
+
19
+ ### In the Works
20
+ - We are putting the finishing touches on [managed Publishing](https://dendron.so/notes/ae4a0c98-e2ea-47e0-8a20-016eba3424be.html). Updates on the launch later this week (for real this time) 😅
21
+
22
+ ### Community
23
+
24
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
25
+ You can see an overview of all roles [[here|dendron.community.roles]]
26
+
27
+ - [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
28
+ - [don't delete text when extracting fro non-vault file](https://github.com/dendronhq/dendron/pull/471)
29
+ - [Nikita Voloboev](https://github.com/nikitavoloboev) @nikivi#5640 `+@Horticulturalist`
30
+ - [add default description to published sites](https://github.com/dendronhq/dendron/pull/472)
31
+
32
+ ### Version Number
33
+ This release comes with the following versions:
34
+ - dendron plugin: 0.28
35
+ - dendron cli: 0.28.2
36
+ - dendron 11ty: 1.28.3
37
+ - dendron plugin and dendron markdown preview will be auto-installed by VSCode
38
+
39
+ - See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
40
+
41
+ ![[dendron.release.changelog#0272:#0261]]

Added: vault/dendron.release.2021-02-15.md

Files changed (1) hide show
  1. vault/dendron.release.2021-02-15.md +31 -0
vault/dendron.release.2021-02-15.md ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ id: 7aab0296-c1be-4f27-af22-1d97293da7d6
3
+ title: Release Notes (version 0.29)
4
+ desc: ''
5
+ updated: 1613450410034
6
+ created: 1613449712126
7
+ ---
8
+
9
+ Dendron 0.29 has sprouted 🌱
10
+
11
+ ### Highlights
12
+ - managed publishing (early preview) is here
13
+ - frontmatter can now be folded
14
+ - last modified times on published pages
15
+ - lots of performance improvements
16
+ - lots of bug fixes
17
+
18
+ ### Community
19
+
20
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
21
+ You can see an overview of all roles [[here|dendron.community.roles]]
22
+
23
+ - [Peter Ritchie](https://github.com/peteraritchie)
24
+ - [fix broken link in docs](https://github.com/dendronhq/dendron/pull/378)
25
+ - [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
26
+ - [Add option to configure human readable ts formatting](https://github.com/dendronhq/dendron/pull/479)
27
+ - [Provide folding range in frontmatter](https://github.com/dendronhq/dendron/pull/487)
28
+ - [Daniel Chapman](https://github.com/dschapman)
29
+ - [Manually Triggering Intellisense doesn't work if an alias is more than one word](https://github.com/dendronhq/dendron/issues/473)
30
+
31
+ ![[dendron.release.changelog#0281:#0272]]

Added: vault/dendron.release.2021-02-22.md

Files changed (1) hide show
  1. vault/dendron.release.2021-02-22.md +39 -0
vault/dendron.release.2021-02-22.md ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: 8d76cb22-f14c-438c-821e-37c91d1b857a
3
+ title: Release Notes (version 0.30)
4
+ desc: ''
5
+ updated: 1614139494099
6
+ created: 1614059104275
7
+ ---
8
+
9
+ Dendron 0.30 has sprouted 🌱
10
+
11
+ ### Highlights
12
+ - experimental nunjucks templates
13
+ - support for private vaults
14
+ - dynamic popovers for unpublished links
15
+ - lots of enhancements and bug fixes
16
+
17
+ ### In the Works
18
+ - custom domains for [[managed publishing|dendron.rfc.2-managed-publishing]]
19
+
20
+ ### Community
21
+
22
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
23
+ You can see an overview of all roles [[here|dendron.community.roles]]
24
+
25
+
26
+ - [flammehawk](https://github.com/flammehawk) @fudo#1010
27
+ - [issue labeling automation](https://github.com/dendronhq/dendron/pull/453)
28
+ - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
29
+ - issue with doctor cli command
30
+ - [Bryan Jenks](https://github.com/tallguyjenks) @tallguyjenks#3567 `+@Taxonomist`
31
+ - fix bad links
32
+ - [Cameron Yick](https://github.com/hydrosquall) @cameron#9185 `+@Planter` `+@Taxonomist`
33
+ - fix typpo
34
+ - [Mandar Vaze](https://github.com/mandarvaze)
35
+ - fix bad doc link
36
+ - [Stedag](https://github.com/Stedag)
37
+ - fix typo
38
+
39
+ ![[dendron.release.changelog#0292:#0281]]

Added: vault/dendron.release.2021-03-01.md

Files changed (1) hide show
  1. vault/dendron.release.2021-03-01.md +41 -0
vault/dendron.release.2021-03-01.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: 1dad9378-8fcf-4859-bede-cc44279ba12d
3
+ title: Release Notes (version 0.31)
4
+ desc: ''
5
+ updated: 1614640820802
6
+ created: 1614636249937
7
+ ---
8
+
9
+ Dendron 0.31 has sprouted 🌱
10
+
11
+ This is probably the biggest release we've had in 2021!
12
+ Lots of goodies to make dendron and [[multi vault|dendron.topic.multi-vault]] work better. Enjoy responsibility :)
13
+
14
+ ### Highlights
15
+ - [[cross vault links|dendron.topic.links#cross-vault-links]] let you specify links to notes in multi-vault workspaces
16
+ - note references now work across vaults
17
+ - backlinks are also generated during publishing
18
+ - you can now extend dendron with [[custom pods|dendron.topic.pod.custom]] to publish your notes to different destinations
19
+ - usual round of bug fixes and performance improvements
20
+
21
+ ### Community
22
+
23
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
24
+ You can see an overview of all roles [[here|dendron.community.roles]]
25
+
26
+ - [Bassmann](https://github.com/Bassmann) @Bassmann
27
+ - [Remove vault doesn't remove entry from payload in dendron.yml](https://github.com/dendronhq/dendron/issues/505)
28
+ - [Philip Whiteside](https://github.com/PhilipWhiteside)
29
+ - [Issue selecting secondary vault](https://github.com/dendronhq/dendron/issues/495)
30
+ - [Can't open assets from secondary vault](https://github.com/dendronhq/dendron/issues/504)
31
+ - [Oli Crask](https://github.com/olivercrask) @Oli916
32
+ - [Published multi-vault navigation pane opens incorrect dropdown](https://github.com/dendronhq/dendron/issues/501)
33
+ - @pcblazef +`@BugCatcher`
34
+ - [links not clickable inside ref](https://github.com/dendronhq/dendron/issues/511)
35
+ - [Nikita Khomitsevych](https://github.com/hamsternik)
36
+ - fix bad link
37
+ - [Simon J S Liu](https://github.com/wind13) @Simon Liu +`@BugCatcher`
38
+ - [Can not search Chinese in web site](https://github.com/dendronhq/dendron/issues/499)
39
+
40
+
41
+ ![[dendron://dendron-site/dendron.release.changelog#0302:#0292]]

Added: vault/dendron.release.2021-03-08.md

Files changed (1) hide show
  1. vault/dendron.release.2021-03-08.md +36 -0
vault/dendron.release.2021-03-08.md ADDED
@@ -0,0 +1,36 @@
1
+ ---
2
+ id: e4be70f5-e035-4e11-b915-3a3508cd9d6b
3
+ title: Release Notes (version 0.32)
4
+ desc: ''
5
+ updated: 1615242232695
6
+ created: 1615241525434
7
+ ---
8
+
9
+
10
+ Dendron 0.32 has sprouted 🌱
11
+
12
+ ### Highlights
13
+ - custom domain names for managed publishing
14
+ - changelog for published pages (experimental)
15
+ - usual round of bug fixes and performance improvements
16
+
17
+ ### Community
18
+
19
+ A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
20
+ You can see an overview of all roles [[here|dendron.community.roles]]
21
+
22
+ - [Cameron Yick](https://github.com/hydrosquall) @cameron#9185
23
+ - [Paste link command](https://github.com/dendronhq/dendron/pull/512)
24
+ - [Derek Ardolf](https://github.com/ScriptAutomate) @ScriptAutomate#6833
25
+ - fix typos
26
+ - [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
27
+ - [Clean up config after vault remove command by hikchoi · Pull Request #517 · dendronhq/dendron](https://github.com/dendronhq/dendron/pull/517)
28
+ - [Consolidate testing convention by hikchoi · Pull Request #527 · dendronhq/dendron](https://github.com/dendronhq/dendron/pull/527#pullrequestreview-605945027)
29
+ - [Shekhar Neupane](https://github.com/neupsh) `+@taxonomist`
30
+ - fix typos
31
+ - [Ben Vautier](https://github.com/Orcomp) @bvautier#1882 `+@taxonomist`
32
+ - add windows dev docs
33
+ - [Boxian](https://github.com/b0xian) @boxian#6506 `+@bugcatcher`
34
+ - [True Portability for Dendron · Issue #522 · dendronhq/dendron](https://github.com/dendronhq/dendron/issues/522)
35
+
36
+ ![[dendron.release.changelog#0313:#0310]]

Added: vault/dendron.release.changelog.0-1-x.md

vault/dendron.release.changelog.0-1-x.md ADDED
@@ -0,0 +1,936 @@
1
+ ---
2
+ id: ed4162aa-5474-4483-9fbc-c0b505310c59
3
+ title: 0.1.X
4
+ desc: ''
5
+ updated: 1614924050223
6
+ created: 1610397097347
7
+ ---
8
+ ## 0.19.3
9
+
10
+ ### Bug Fixes
11
+
12
+ - be able to name remote vaults ([6da3973](https://github.com/dendronhq/dendron/commit/6da39730f735f4700479f002f57d2a7802398ff5))
13
+ - doctor command shouldn't create stubs ([e812f34](https://github.com/dendronhq/dendron/commit/e812f34246d88b007fb45ca03443a74ac27a5e62))
14
+ - help command not working ([02fc08a](https://github.com/dendronhq/dendron/commit/02fc08a907e196b39c23db36b82565c15588673f))
15
+ - nested git repos not showing up in source control view ([37adc5e](https://github.com/dendronhq/dendron/commit/37adc5e528e0b9fa6c86105b39ebb40384023da4))
16
+ - clicking a stub on tree view would show a false error ([ea0e17e](https://github.com/dendronhq/dendron/commit/ea0e17e7ec8afed44cee1fd0fe442ba4c2064f92))
17
+
18
+ ## 0.19.2
19
+
20
+ ### Features
21
+
22
+ #### Dendron Seed Bank
23
+
24
+ ((ref:[[dendron.topic.seed-bank]]))
25
+
26
+ #### Support refactor for multi-vault
27
+
28
+ One of our most requested features for multi-vault is now out. Refactor will now work across multiple vaults. All rename operations take place in the same vault as the file being renamed (so a refactor operation that affects files in multiple vaults will end up renaming files within each vault). You can see an example of this below:
29
+
30
+ ```
31
+ .
32
+ ├── vault1
33
+ │ └── bond.one
34
+ └── vault2
35
+ └── bond.two
36
+ ```
37
+
38
+ - after refactoring `bond -> james`
39
+
40
+ ```
41
+ .
42
+ ├── vault1
43
+ │ └── james.one
44
+ └── vault2
45
+ └── james.two
46
+ ```
47
+
48
+ #### Support Specifying Vault Location when Creating a Note
49
+
50
+ ((ref:[[dendron.topic.multi-vault]]#specify vault location when creating a note,1:#*))
51
+
52
+ ### Enhancements
53
+
54
+ - add aws to the seed bank ([818bc05](https://github.com/dendronhq/dendron/commit/818bc0510e3b3b99057ef7cda8d9c61be2b6ebc6))
55
+ - nicer refactor formatting ([0e7749a](https://github.com/dendronhq/dendron/commit/0e7749a175a0ce80903cde5c9773649779100a9c))
56
+ - add remote vault to gitignore if exist ([1c252db](https://github.com/dendronhq/dendron/commit/1c252db60c0ea69be8dd10c1768c2dd302711e13))
57
+ - initialize all remote vaults on startup ([1919fe4](https://github.com/dendronhq/dendron/commit/1919fe4e6d853d1f6ef63564ebbcc9af1e11a41a))
58
+ - write remote url to dendron config ([2a285ea](https://github.com/dendronhq/dendron/commit/2a285eacaeef8224d2a3530dc991b4977443c039))
59
+ - add github sponsor badge on github repository to recruit more [[environmentalists|dendron.community.roles#environmentalist]] 👨‍🌾 👩‍🌾
60
+
61
+ ### Bug Fixes
62
+
63
+ - completion on schema suggestions ([223d6a5](https://github.com/dendronhq/dendron/commit/223d6a501bd9e51331d28e21d77408b7ca3fba50))
64
+
65
+ ## 0.19.1
66
+
67
+ ### Bug Fixes
68
+
69
+ - image preview regex match wrong range
70
+
71
+ ## 0.18.2
72
+
73
+ ### Features
74
+
75
+ - support image hover ([8fee313](https://github.com/dendronhq/dendron/commit/8fee313785dfc4ac2564f74911a4b51879be0673))
76
+
77
+ ```
78
+ - you can now hover over markdown image links and get the image preview
79
+ ```
80
+
81
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/82119bc9ee184e3ca8e619c3d7e48209" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
82
+
83
+ ### Enhancements
84
+
85
+ - faster completion ([d9d4598](https://github.com/dendronhq/dendron/commit/d9d4598c1996fdb5eb24e4bda0e51e777b476f6e))
86
+
87
+ ### Bug Fixes
88
+
89
+ - doctor errors when backfilling frontmatter ([862e917](https://github.com/dendronhq/dendron/commit/862e9173e92a2e5d964273bb87c19e79177a6200))
90
+ - properly parsing links that start at beginning of line ([b2dbdfc](https://github.com/dendronhq/dendron/commit/b2dbdfc9e49aa1fa74d5097500eeaddf05bf7ccc))
91
+ - limit completion prompts to inside wiki links ([f49972e](https://github.com/dendronhq/dendron/commit/f49972ee436f9f637bd68729e702ba2169e68faf))
92
+ - adding local vault with fail if using relative path ([fb202e9](https://github.com/dendronhq/dendron/commit/fb202e91e501cfd5506fd73c9a005807954e48d3))
93
+ - make completion match the whole link ([d9d4598](https://github.com/dendronhq/dendron/commit/d9d4598c1996fdb5eb24e4bda0e51e777b476f6e))
94
+ - tree view containing out of date hierarchy
95
+ - alias notes will no longer display alias portion as part of the link when publishing
96
+
97
+ ## 0.18.1
98
+
99
+ ### Features
100
+
101
+ #### Support adding remote vaults
102
+
103
+ - commit: ([d7501b9](https://github.com/dendronhq/dendron/commit/d7501b9a5cb116faae64d26798cfd7ccfc73a4b0))
104
+
105
+ You can now natively add published Dendron git repos as a _remote vault_ inside Dendron. These vaults are stored in a custom `repos` folder underneath your `workspaceRoot`. Since a remote vault is just a git repo, you are able to perform all the usual git operations on it like `push`, `pull`, `merge`, and `blame`.
106
+
107
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/ef3fa948460c4f2cb4f7a7b8242579d1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
108
+
109
+ ### Enhancements
110
+
111
+ - support pods for multi-vault ([661fe21](https://github.com/dendronhq/dendron/commit/661fe218d448e6f32f86bf60dabe635b71d67251))
112
+ - much faster lookup performance for large vaults 🚀🚀🚀 ([3ddeba8](https://github.com/dendronhq/dendron/commit/3ddeba8a596be4bc9316e0cc5e63025d7bf4460f))
113
+ - support [[sibling nav|dendron.topic.commands#go-next-sibling]] for multi-vault ([235bfc7](https://github.com/dendronhq/dendron/commit/235bfc77505b403bf32c78ce3df6b7005c37dfba))
114
+
115
+ ### Bug Fixes
116
+
117
+ - publishing fails in some cases when multi-vault is enabled ([0ebac81](https://github.com/dendronhq/dendron/commit/0ebac8191291f48ab42fbc30279e9615c96a5245))
118
+ - journal and scratch notes fail in some cases for multi-vault ([5c04ccd](https://github.com/dendronhq/dendron/commit/5c04ccd666511abb79554b7a24c02efd46d93c3a))
119
+ - multiple commands not working properly for multi-vault([fd5a381](https://github.com/dendronhq/dendron/commit/fd5a381674384588850b07b193fc0bf609abc0fd))
120
+
121
+ ### House Cleaning
122
+
123
+ - breaking: the [[go to sibling|dendron.topic.commands#go-next-sibling]] commands have a new keyboard shortcut since the old one was conflicting with the vscode default. the new shortcuts are `ctrl+shift+]` and `ctrl+shift+[`
124
+
125
+ ## 0.17.2
126
+
127
+ ### Features
128
+
129
+ #### Dendron Web UI 🚧
130
+
131
+ During office hours and onboardings, many of you said how you loved Dendron's functionality but wished that it was a little easier to use, especially on the UI front.
132
+
133
+ This is why I'm excited to introduce Dendron's first Web UI - an interface build using modern web technologies integrated into VSCode.
134
+
135
+ This initial launch features the Dendron Configuration editor. Prior to the UI, you would have to manually edit YAML to update the configuration. With the web ui, you no longer have to understand YAML and your changes will be validated before being saved.
136
+
137
+ The configuration editor is just the first step in making Dendron easier to use and expect to see more updates on this front soon.
138
+
139
+ Note that the Web UI is still deemed experimental and functionality like keyboard shortcuts currently don't work.
140
+
141
+ Special thanks to [Tyler Nieman](https://github.com/tsnieman) for the UI work!
142
+
143
+ ((ref:[[dendron.topic.commands]]#configure,1:#*))
144
+
145
+ ### Enhancements
146
+
147
+ - update config commands ([44dce76](https://github.com/dendronhq/dendron/commit/44dce76b6fd447cd29a2f4f594632ef758eff927))
148
+ - enable rename with multi-vault ([e26b294](https://github.com/dendronhq/dendron/commit/e26b294e8bbe1e49e44318152c247595e82639bb))
149
+ - tree view and backlinks panel no longer appear when Dendron is not active (thank you [Christopher Corley](https://github.com/cscorley))
150
+
151
+ ### Bug Fixes
152
+
153
+ - rename would fail if backlink existed at root note
154
+ - numerous fixes to refactor hierarchy
155
+
156
+ ### House Cleaning
157
+
158
+ - the `Dendron: Configure` command will now launch the config editor with the web ui
159
+ - the old `Dendron: Configure` command as been renamed to `Dendron: Configure (yaml)`
160
+
161
+ ## 0.17.1
162
+
163
+ ### Features
164
+
165
+ #### Automatic Hover's for Links
166
+
167
+ - add hover provider ([8d19a1b](https://github.com/dendronhq/dendron/commit/8d19a1b47f114ae738f7483fd751b62f68b46d24))
168
+
169
+ You can now preview notes and references inside the editor as a hover without ever opening the link. Previews are compatible with note references and will show references as inlined markdown.
170
+
171
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/aee387226d5c4bb0a4e38cee76a1aa3e" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
172
+
173
+ ### Bug Fixes
174
+
175
+ - **workbench:** copy header cmd will sometimes chop of last character ([34c2530](https://github.com/dendronhq/dendron/commit/34c253036cf959ef00620db9063c8de36ae9c848))
176
+ - **markdown:** relative links sometimes don't resolve ([c1ffa54](https://github.com/dendronhq/dendron/commit/c1ffa54ab780bec98cb5b322b4d0905cc26acce7))
177
+
178
+ ### Work in Progress
179
+
180
+ - continued multi-vault compatibility for existing features
181
+ - integrating [Dendron's first Web UI component](https://github.com/dendronhq/dendron/pull/351)
182
+ - backend changes to enable new [[multi vault layout|dendron.roadmap.project.n.2020.multi-vault#initialization]]
183
+ - heaps of performance and stability improvements
184
+
185
+ ## 0.16.3
186
+
187
+ ### Enhancements
188
+
189
+ - **language**: better completion on partial links ([e7489b3](https://github.com/dendronhq/dendron/commit/e7489b324fb8b5b1a0cb3daf4bd33978073bd90a))
190
+ - **workbench**: remove color theme and minimap presets ([6b6bd8d](https://github.com/dendronhq/dendron/commit/6b6bd8d1b866bfe881b8ed7c341e5f2191bfa741))
191
+ - **publishing**: support relative links in publishing ([d7d612d](https://github.com/dendronhq/dendron/commit/d7d612d00bf0fedfc5e7dc9beda1e00927be83a9))
192
+ - **notes:** rename the frontmatter title when note is renamed ([32c77a1](https://github.com/dendronhq/dendron/commit/32c77a1a97162150b88c97c9266bd2a42a816aa0))
193
+ - **workbench:** auto upgrade deprecated workspace settings
194
+
195
+ ### Bug Fixes
196
+
197
+ - **language**: re-enable preview functionality when peeking at a definition ([afe71c4](https://github.com/dendronhq/dendron/commit/afe71c41daff3acc935cb5bed7b51d20ef8e6267))
198
+ - **language**: creating a note by going to its definition now respects schema templates
199
+ - **workbench**: initialize dendron in the absence of a workspace file ([c1aabb4](https://github.com/dendronhq/dendron/commit/c1aabb4a6b2084990269ea169c1a90d800b430c3))
200
+ - **workbench**: cancel adding a vault if input is blank ([86baed6](https://github.com/dendronhq/dendron/commit/86baed6e0938132709e4cfbd2008f1f8fadc77cb))
201
+ - **pods:** publish issue when multi-vault is enabled ([cc50327](https://github.com/dendronhq/dendron/commit/cc503276a0ca0545e2793449f7382bc810216377))
202
+ - **ui:** note will show up in wrong place in treeview when multi-vault is enabled ([6daeebc](https://github.com/dendronhq/dendron/commit/6daeebc7bd2bbc68fc105766d30bc10444bcaf61))
203
+
204
+ ## 0.16.2
205
+
206
+ - NOTE: with this change, Dendron now has all the functionality of **Dendron Markdown Notes** built-in (and then some). To make sure you get the new link functionality, uninstall Dendron Markdown Notes
207
+
208
+ ![uninstall ](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/etc.install.jpg)
209
+
210
+ ### Features
211
+
212
+ #### Support Relative Wiki Links
213
+
214
+ You can now navigate to a specific section within a note using relative wiki links: `[[foo#header]]`
215
+
216
+ Note that the header is expected in [github slug](https://github.com/gosimple/slug) format. This means that spaces and special characters should be replaced with `-`.
217
+
218
+ - **NOTE**: Relative wiki links currently don't work in the markdown-preview
219
+
220
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b21501b47e64449882a369590a630d7f" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
221
+
222
+ #### Copy Relative Wiki Links
223
+
224
+ Similarly to copying a note ref, if you select any part of a header while running `Copy Note Link`, a relative wiki-link will be automatically generated.
225
+
226
+ ((ref:[[dendron.topic.commands]]# copy note link:# *))
227
+
228
+ #### All link features are now multi-vault aware
229
+
230
+ Link related features like navigation and auto complete can now detect notes in all vaults.
231
+
232
+ When the same note exists in multiple vaults, Dendron will show you a prompt to pick the note you want to navigate to.
233
+
234
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/1108e35e262c4d428629d0a4034090d0" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
235
+
236
+ #### Link Completion with Aliases
237
+
238
+ You can now auto complete notes that have aliases. This was a common issue for folks that were using [[pretty tags|dendron.topic.tags]]
239
+
240
+ ### Bug Fixes
241
+
242
+ - Issue with creating notes with same name in a new vault
243
+
244
+ ### House Cleaning
245
+
246
+ - remove dependency on markdown-notes
247
+
248
+ ## 0.16.1
249
+
250
+ ### Bug Fixes
251
+
252
+ - new dendron installation missing welcome note
253
+
254
+ ## 0.15.3
255
+
256
+ ### Features
257
+
258
+ #### Better Lookup Performance 🚀 🚀 🚀
259
+
260
+ We've made a whole bunch of optimizations to make lookup hum. You should notice everything about it feel a little faster now
261
+
262
+ Changelog:
263
+
264
+ - **lookup:** multiple lookup optimizations([f14eed8](https://github.com/dendronhq/dendron/commit/f14eed8da822eb75f130edb7364a1f9f0c2fe354))
265
+ - **lookup:** intelligently debounce queries ([2f0ac56](https://github.com/dendronhq/dendron/commit/2f0ac56bd6f64d0b99fcb82d6effa9f062d18fc2))
266
+
267
+ ### Enhancements
268
+
269
+ - update getting started ([af5dde9](https://github.com/dendronhq/dendron/commit/af5dde91d153ce46089c8688caec0e583eddb939))
270
+ - instead of 100+ notes, new vaults will be initialized with a single quickstart note (with links to the 100+ notes)
271
+
272
+ - better logging ([2d7fd78](https://github.com/dendronhq/dendron/commit/2d7fd780d3c548a362dcf01a2620409b1bcdff3e))
273
+ - let logs talk for you the next time you submit [an issue](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title) (no 🌲 harmed in this process)
274
+
275
+ - nicer error messages ([e1e87a1](https://github.com/dendronhq/dendron/commit/e1e87a16186b1e8b8aae6f77fe8a2c5c865c4071))
276
+ - we'll let you know if you need to submit an issue instead of giving you the silent treatment
277
+
278
+ - keep old log files ([3f1362c](https://github.com/dendronhq/dendron/commit/3f1362c224ff7dae5de721dd2f2c8cba22db4d84))
279
+ - dendron currently wipes all logs on startup. this change makes it keep around the last log for debugging purposes
280
+
281
+ ### Bug Fixes
282
+
283
+ - creating scratch notes can sometimes fail ([c31c611](https://github.com/dendronhq/dendron/commit/c31c611d975b8eeee4f63abec742edf88dac66ac))
284
+ - sync issues btw server and client nodes that would cause certain commands to fail ([a446aba](https://github.com/dendronhq/dendron/commit/a446aba9d931d7732553e1ecb43302208d6f798a))
285
+
286
+ ## 0.15.2
287
+
288
+ ### Features
289
+
290
+ #### Experimental Multi-Vault Support
291
+
292
+ (Early Experimental ) [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]] is here! Multi Vault lets you add additional [vaults](https://dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#vaults-) to your Dendron workspace.
293
+
294
+ Each vault is logically separate (they reside in separate directories) but can be universally queried using lookup.
295
+
296
+ Multi vault enables a bunch of exciting use cases.
297
+
298
+ ((ref:[[dendron.roadmap.project.n.2020.multi-vault]]#use cases,1:#*))
299
+
300
+ Currently, the following commands are supported with multi-vault:
301
+
302
+ - Lookup
303
+ - Deleting a Note
304
+ - Navigating to a note using Tree View
305
+
306
+ Other commands like rename/refactor will still work when performed in your primary vault. They will probably not work if performed against a note not inside your primary vault.
307
+
308
+ When you use **Lookup** to create a new note with multi vault, the note will be created inside the same vault as the current opened note. **Lookup** will also show you the vault that each note belongs to while performing lookup.
309
+
310
+ Currently known issues (with supported commands):
311
+
312
+ - unable to create a note using Lookup that has the same name as an existing note inside **any** of your vaults
313
+ - unable to navigating to the root of a vault using Tree View
314
+
315
+ #### Vault Add Command
316
+
317
+ Add a new vault to your workspace.
318
+
319
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
320
+
321
+ #### Vault Remove Command
322
+
323
+ Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
324
+
325
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
326
+
327
+ ### Enhancements
328
+
329
+ ### Bug Fixes
330
+
331
+ - **engine:** init with empty config won't throw error ([7beb90f](https://github.com/dendronhq/dendron/commit/7beb90fa243bc73563a3ce16b5305345f7348d9f))
332
+ - **engine:** don't delete old note if new note wasn't created by rename ([de44f9f](https://github.com/dendronhq/dendron/commit/de44f9f4d38651d75433ae885fdc78bb762fb1f6))
333
+ - **notes:** fix issue when importing note that already exists ([a08a34a](https://github.com/dendronhq/dendron/commit/a08a34a0563bb4047bd9c7cfc5f2bf150873fdc8))
334
+
335
+ ### House Cleaning
336
+
337
+ - vault metadata will be added to `dendron.yml`
338
+ - `dendron.yml` comments will be stripped on workspace initialization
339
+
340
+ ## 0.15.1
341
+
342
+ ### Features
343
+
344
+ #### Wildcard Note Ref Links
345
+
346
+ - **refs:** wildcard note ref links ([98a1177](https://github.com/dendronhq/dendron/commit/98a117715a967492ab9d7b8749d964b07bde4055))
347
+
348
+ ((ref:[[dendron.topic.refs]]#wildcard note refs,1))
349
+
350
+ #### Dendron: Configure Command
351
+
352
+ - **workbench:** add configure command ([db51dc3](https://github.com/dendronhq/dendron/commit/db51dc35864d0c4434f70620ef0e88451c198fa4))
353
+
354
+ This is a quick way to update the `dendron.yml` file. You can run it by using `Dendron: Configure`
355
+
356
+ ### Bug Fixes
357
+
358
+ - **notes:** fix issue when importing note that already exists ([a08a34a](https://github.com/dendronhq/dendron/commit/a08a34a0563bb4047bd9c7cfc5f2bf150873fdc8))
359
+
360
+ ### House Cleaning
361
+
362
+ - add `.dendron.ws` file under workspace to store workspace specific metadata
363
+
364
+ ## 0.14.2
365
+
366
+ ### Features
367
+
368
+ ### Enhancements
369
+
370
+ - **pods:** better markdown import pod (d1eaa264)
371
+ - address multiple edge cases that would cause import pod to fail
372
+ - auto-convert wiki-links from folder-based systems like obsidian into dendron
373
+ - **cli:** launch engine server using cli ([25eae3f](https://github.com/dendronhq/dendron/commit/25eae3fddd6a2d26dcf9e2f3e664b377c2cca978))
374
+
375
+ ((ref:[[dendron.topic.cli]]#launchengineserver:#*))
376
+
377
+ - **workspace:** write server port in workspace ([6a0ff84](https://github.com/dendronhq/dendron/commit/6a0ff845ebbf010073b271123779fc3f56ac2821))
378
+ - used by bundled extensions to talk to dendron server
379
+ - **engine:** add sync method ([ec58d39](https://github.com/dendronhq/dendron/commit/ec58d395003640384b7764f4f8b483429cc1ece3))
380
+ - used by bundled extensions to talk to dendron server
381
+
382
+ ### Bug Fixes
383
+
384
+ - **engine:** properly handle \* in refs when refactoring ([704a14f](https://github.com/dendronhq/dendron/commit/704a14f17196e18cb5b26f5fc98ed9f8d492e16a))
385
+ - **workbench:** fix daily journal note command signature ([5ec96ef](https://github.com/dendronhq/dendron/commit/5ec96efd9a006e5e5999f2704dfb3d1e97e60a5c))
386
+
387
+ ## [0.14.1](https://github.com/dendronhq/dendron/compare/v0.14.1-alpha.7...v0.14.1) (2020-11-05)
388
+
389
+ ### Features
390
+
391
+ #### Lookup Copy WikiLink Modifier
392
+
393
+ - **lookup:** copy note link cmd ([e38743d](https://github.com/dendronhq/dendron/commit/e38743ddbac8486f2ac778bd546a6373a15a4f6d))
394
+
395
+ ((ref:[[dendron.topic.lookup.modifiers]]#copywikilink,1:#*))
396
+
397
+ #### Lookup Multi-Select Modifier
398
+
399
+ - **lookup:** support multi-select ([b409c05](https://github.com/dendronhq/dendron/commit/b409c05d3b19797de714dbf10b6a4249758eae8a))
400
+
401
+ ((ref:[[dendron.topic.lookup.modifiers]]#multiselect,1:#*))
402
+
403
+ ### House Cleaning
404
+
405
+ #### Code Cleanup
406
+
407
+ With the server migration behind us, we took some time to make Dendron more hygenic by removing old code and consolidating existing code. All in all, we eliminated ~8k lines. If you are currently working on a branch, I suggest you merge with master to get the latest changes 😅
408
+
409
+ - before cleanup
410
+
411
+ ```
412
+ -------------------------------------------------------------------------------
413
+ Language files blank comment code
414
+ -------------------------------------------------------------------------------
415
+ JSON 73 6 0 72744
416
+ TypeScript 246 3089 3089 31790
417
+ Markdown 50 4682 0 5947
418
+ JavaScript 16 168 76 1349
419
+ Bourne Shell 23 40 9 179
420
+ YAML 13 3 3 158
421
+ CSS 2 17 32 72
422
+ HTML 1 0 0 14
423
+ SVG 1 0 0 12
424
+ -------------------------------------------------------------------------------
425
+ SUM: 425 8005 3209 112265
426
+ -------------------------------------------------------------------------------
427
+ ```
428
+
429
+ - after cleanup
430
+
431
+ ```
432
+ -------------------------------------------------------------------------------
433
+ Language files blank comment code
434
+ -------------------------------------------------------------------------------
435
+ JSON 73 6 0 72745
436
+ TypeScript 224 2343 1810 24352
437
+ Markdown 34 4772 0 5974
438
+ JavaScript 16 168 76 1349
439
+ Bourne Shell 24 40 9 181
440
+ YAML 6 3 3 78
441
+ CSS 2 17 32 72
442
+ HTML 1 0 0 14
443
+ SVG 1 0 0 12
444
+ -------------------------------------------------------------------------------
445
+ SUM: 381 7349 1930 104777
446
+ -------------------------------------------------------------------------------
447
+ ```
448
+
449
+ ## 13.6
450
+
451
+ ### Features
452
+
453
+ #### Add Contribute Command
454
+
455
+ - **workbench:** ([130a58a](https://github.com/dendronhq/dendron/commit/130a58a62cc40eb4178afac554f8f4ff30c93055))
456
+
457
+ ((ref:[[dendron.topic.commands]]#contribute:#*))
458
+
459
+ #### Add Snapshot Capability to Dendron
460
+
461
+ - **workbench:** ([3af64b7](https://github.com/dendronhq/dendron/commit/3af64b701d47ed28818d7e6017c758f63be617f0))
462
+
463
+ ((ref:[[dendron.topic.capabilities.snapshot]]#Snapshots:#*))
464
+
465
+ ## [0.13.5](https://github.com/dendronhq/dendron/compare/v0.13.4...v0.13.5) (2020-10-28)
466
+
467
+ ### Bug Fixes
468
+
469
+ - **workbench:** tree view can delete notes with caps ([d37926d](https://github.com/dendronhq/dendron/commit/d37926d7f38d784f847a4c2a58fb75ba7c03b0e0))
470
+
471
+ ## [0.13.4](https://github.com/dendronhq/dendron/compare/v0.13.4-alpha.1...v0.13.4) (2020-10-28)
472
+
473
+ ### Features
474
+
475
+ #### Migrate Existing Workspaces to Server Mode
476
+
477
+ - commit ([d19b6ec](https://github.com/dendronhq/dendron/commit/d19b6ecb97fb60d8706e14f0181795113b5e108b))
478
+
479
+ This is the last phase in Dendron's server mode migration. All new workspaces are already running in server mode as well as well as users that have opted into it. This update transparently migrates remaining workspaces to server mode.
480
+
481
+ As a reminder, [[server mode|dendron.roadmap.project.n.2020.server-migration]] is a re-architecture of Dendron that enables both better performance and a vast array of new features.
482
+
483
+ Finally, we do have an escape valve in things something goes terribly wrong. You can set the following option to revert server mode behavior. If you end up using this, please also cut as [a ticket](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title=) or a message in [discord](https://discord.gg/QbKsNx).
484
+
485
+ ### Enhancements
486
+
487
+ - **notes:** selection2link will auto generate a title based on the selection ([9964339](https://github.com/dendronhq/dendron/commit/9964339138bde18dc022fdd62ce9ba9d529cfa2b))
488
+
489
+ - **workbench:** graceful failure on bad schema ([4db5064](https://github.com/dendronhq/dendron/commit/4db5064e4eef61d9c95b9abe34f2dec41550bd9d))
490
+ - instead of refusing to initialize, Dendron will skip bad schemas and generate an error report post-startup
491
+
492
+ - **workbench:** nicer error messages ([9e371e1](https://github.com/dendronhq/dendron/commit/9e371e132b565ae2abebaa2bf1307a5a03a91b9b))
493
+ - certain errors now have human friendly messages instead of JSON goop
494
+
495
+ ### Bug Fixes
496
+
497
+ - **workbench:** read json config with comments ([1741553](https://github.com/dendronhq/dendron/commit/1741553695b1c7cced54bf04b26700076a38a19c))
498
+ - Dendron gets sad if your workspace has comments
499
+
500
+ ### Community
501
+
502
+ #### Horticulturalist
503
+
504
+ Dendron now has a new role -> the **Horticulturalist**. These are folks who have contributed to the Dendron code base: 👨‍🌾👩‍🌾
505
+
506
+ Kudos to **@britt#3020** and **@lukecarrier#2081** for being the first to earn this distinction!
507
+
508
+ #### Dendrologist
509
+
510
+ Excited to welcome a new dendrologist --> @I'm a lightbulb#6986
511
+
512
+ @I'm a lightbulb#6986 was one of our earliest users and one of the first to [publish](https://dendron.so/notes/3a82c5ff-7945-46ae-8bf9-3b2275fc6642.html#jacks-page) using dendron.
513
+
514
+ As a reminder, dendrologist are active members of the community who are recognized with said title and a few additional discord super powers.
515
+
516
+ ## [0.13.3](https://github.com/dendronhq/dendron/compare/v0.13.3-alpha.1...v0.13.3) (2020-10-24)
517
+
518
+ ### Features
519
+
520
+ #### Direct Child Filter
521
+
522
+ - **lookup:** support direct child filter ([1cae082](https://github.com/dendronhq/dendron/commit/1cae08294baa844c0c0ee3c8d390e337bd6172be))
523
+
524
+ ((ref:[[dendron.topic.lookup]]#filter toggle,1:#*))
525
+
526
+ - you can create a keyboard shortcut to do a lookup with the direct child filter pre-selected
527
+ ((ref:[[dendron.topic.lookup.modifiers]]#filtertype:#*))
528
+
529
+ ### Enhancements
530
+
531
+ - **publish:** be able to set config for all hierarchies ([a27d94a](https://github.com/dendronhq/dendron/commit/a27d94a3c469a4efaf2ee8c2bca40a8a471773f2))
532
+ ((ref:[[dendron.topic.publishing.configuration]]#config:#*))
533
+
534
+ - **schema:** add custom props from schema template ([5264544](https://github.com/dendronhq/dendron/commit/52645449b8e155e168baaac0fa4e99903efafcf0))
535
+
536
+ ((ref:[[dendron.topic.schema]]#schema templates,1:#*))
537
+
538
+ - **workbench:** reload index re-create root if not exist ([c66e242](https://github.com/dendronhq/dendron/commit/c66e242bac91c73404a5dd21ed3813c0dc2f022b))
539
+ - dendron requires `root.md` and `root.schema.yml` to start indexing and would previously throw an error if these files were deleted
540
+ - this change will create these files within the vault instead of throwing said error
541
+
542
+ ### Bug Fixes
543
+
544
+ - **comp:common-server:** don't throw error on missing log vars ([9d00e55](https://github.com/dendronhq/dendron/commit/9d00e55b2104efa7739ec94f0bb2793daa888450))
545
+ - **notes:** refactor will miss links in newly created notes ([c8a5dde](https://github.com/dendronhq/dendron/commit/c8a5dde2ca46e2402bc50b1a8f635d9fb5318c9d))
546
+ - **lookup:** don't update lookup text unless a _note btn_ is pressed ([30140f7](https://github.com/dendronhq/dendron/commit/30140f7a16c6fb5ab81a9eae8af13f17575c78f3))
547
+ - **workbench**: Doctor command will create two `doc` directories if no `doc` directory is found ([43f7bfc9](https://github.com/dendronhq/dendron/commit/43f7bfc9)) --> ( 🙏 thanks to [Britt](https://github.com/bs) for the pull request)
548
+
549
+ ### House Cleaning
550
+
551
+ #### Dendron: Change Workspace will no longer create a workspace if no workspace exists
552
+
553
+ Previously, if you wanted to use an existing folder (aka vault) with a workspace, we recommended you run `Change Workspace` which would create a Dendron workspace **inside** the folder if it didn't exist. This turns out to be an anti-pattern that interferes with features like publishing which expect the workspace to be in a separate folder from its vaults.
554
+
555
+ ## [0.13.2](https://github.com/dendronhq/dendron/compare/v0.13.2-alpha.2...v0.13.2) (2020-10-22)
556
+
557
+ ### Features
558
+
559
+ #### Pod Publishing
560
+
561
+ - **pods:** add publish pod cmd ([8947a60](https://github.com/dendronhq/dendron/commit/8947a60cbc2e76f00d214a1913952c58db86f2f1))
562
+
563
+ In addition to **import** and **export**, you can now also **publish** notes with pods.
564
+
565
+ ((ref:[[dendron.topic.pod]]#publish,1:#*))
566
+
567
+ #### Realtime Schema Validation
568
+
569
+ - **schemas:** realtime schema validation (server mode) ([42191bcd](https://github.com/dendronhq/dendron/commit/42191bcd))
570
+
571
+ You will now get a warning if you are trying to save a badly formatted schema.
572
+
573
+ ### Enhancements
574
+
575
+ - **publishing:** preserve abbreviations ([06d9191](https://github.com/dendronhq/dendron/commit/06d91912b34bc5f81b20fce77652366c501865ec)) --> thank you [Luke Carrier](https://github.com/LukeCarrier) for the pull request
576
+ - **pods:** add json publish pod ([127dd7c](https://github.com/dendronhq/dendron/commit/127dd7c02a0081b027e06c40d6189904c5da0694))
577
+ - **pods:** add markdown publish pod ([127dd7c](https://github.com/dendronhq/dendron/commit/127dd7c02a0081b027e06c40d6189904c5da0694))
578
+ - **pods:** update placeholder text ([57a4af8](https://github.com/dendronhq/dendron/commit/57a4af8887404c21d07b45a3a565516bf73cc944))
579
+ - **refs:** render error when ref doesn't exist ([ba1be1a](https://github.com/dendronhq/dendron/commit/ba1be1a12c4a1742e93ab4058d0f132b320be539))
580
+
581
+ ### Breaking
582
+
583
+ - `dendron.pod.file` has been renamed `dendron.markdown`
584
+ - `dendron.pod.json` has been renamed `dendron.json`
585
+
586
+ ### Documentation Updates
587
+
588
+ #### Pods
589
+
590
+ Documentation for pods has been re-written to reflect recent changes with pods
591
+
592
+ ((ref:[[dendron.topic.pod]]#pods:#*))
593
+
594
+ ## [0.13.1](https://github.com/dendronhq/dendron/compare/v0.13.1-alpha.2...v0.13.1) (2020-10-21)
595
+
596
+ ### Features
597
+
598
+ #### Generate table of contents when Publishing
599
+
600
+ - **publishing:** generate toc when publishing ([53ee270](https://github.com/dendronhq/dendron/commit/53ee270c89f530b9224f33a28dc811de7e5cb2ad))
601
+
602
+ ((ref:[[dendron.topic.publishing.configuration]]#toc:#*))
603
+
604
+ - **publishing:** set frontmatter overrides globally when publishing ([782d637](https://github.com/dendronhq/dendron/commit/782d6374c55b00bcda36da9149fb2cedeac0c3d9))
605
+
606
+ ### Enhancements
607
+
608
+ - **lookup:** add contrast btw note/schema lookup ([4faec8e](https://github.com/dendronhq/dendron/commit/4faec8e4548a80eb56469c46efadd608c26e0230))
609
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.lookup-note.jpg)
610
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.lookup-schema.jpg)
611
+
612
+ ### Bug Fixes
613
+
614
+ - **publish:** issues with Publish command in server mode ([7f3789a](https://github.com/dendronhq/dendron/commit/7f3789a88a01465cca30efe3b3d261bf89a100df))
615
+ - **lookup:** re-enable schema suggestions on namespace ([56ee6c4](https://github.com/dendronhq/dendron/commit/56ee6c460dd562200931381923e72971681d1390))
616
+ - **workbench:** reload index will update tree view ([deadedc](https://github.com/dendronhq/dendron/commit/deadedc30358ee668806434196ddd45b74aff0cc))
617
+ - **lookup:** display schema id if title undefined ([6c7cc70](https://github.com/dendronhq/dendron/commit/6c7cc70cf85181b11654074e17672e39a44fb874))
618
+ - **seeds:** update replace merge strategy to really replace ([a02e08a](https://github.com/dendronhq/dendron/commit/a02e08a753c0603871a1ff76e6de78906a04b056))
619
+
620
+ ## 0.12.11
621
+
622
+ ### Features
623
+
624
+ #### Recursive Note References
625
+
626
+ ((ref:[[dendron.topic.refs]]#recursive reference,1))
627
+
628
+ ### Bug Fixes
629
+
630
+ - **time decorator lose position**: updating the frontmatter will cause the time decorator to sometimes lose its position
631
+ - **time decorator not updating**: turned off temporarily to investigate performance impact
632
+ - **rename note**: doesn't update all links in some cases
633
+
634
+ ### Other
635
+
636
+ - we've created a **bug catcher** role for folks that reported bugs to Dendron. currently trying to backfill with all the people that have contributed bugs. feel free to ping me if I missed you and big thanks to the current bug catchers!
637
+
638
+ ## [0.12.10](https://github.com/dendronhq/dendron/compare/v0.12.10-alpha.4...v0.12.10) (2020-10-16)
639
+
640
+ ### Features
641
+
642
+ #### Rename and Refactor Commands an Order of Magnitude Faster Now (server mode) 🚀🚀🚀
643
+
644
+ These commands have been completely re-written and use a proper markdown parser to find links (vs many fragile regex statements).
645
+ The re-write results in both much faster performance as well as a more correct implementation.
646
+
647
+ ### Enhancements
648
+
649
+ - **progress indicator on startup (server mode)**: loading indicator to help with large workspaces
650
+ - **rename command support (server mode)**: rename command is now available in server mode
651
+ - **refactor command support (server mode)**: refactor hierarchy command is now available in server mode
652
+ - **publish notes support (server mode)**: publish notes command is now available in server mode
653
+ - **archive command support (server mode)**: archive hierarchy is now available in server mode
654
+ - **doctor command support (server mode)**: doctor command is now available in server mode
655
+
656
+ ### Bug Fixes
657
+
658
+ - **schema templates not working (server mode)**: issue where schema templates were not being applied
659
+
660
+ ## [0.12.9](https://github.com/dendronhq/dendron/compare/v0.12.9-alpha.1...v0.12.9) (2020-10-15)
661
+
662
+ ### Features
663
+
664
+ #### Human Friendly Timestamps (server mode)
665
+
666
+ Timestamps now have human friendly decorators on the side.
667
+
668
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/daily.ts.jpg)
669
+
670
+ ### Enhancements
671
+
672
+ - **copyAssets configuration**: when publishing, you can now toggle whether you want to copy assets or not
673
+ - **dump state**: dendron now has a `Dump State` command which will dump the internal state into the logs (useful for debugging)
674
+
675
+ ### Bug Fixes
676
+
677
+ - **assets not being copied:** assets not copied on publishing when `assetsPrefix` was set
678
+ - **GoUp comman go to wrong note (server mode):** GoUp would sometimes try to open a stub node which would result in an error
679
+ - **Multiple workspaces result in bad timestamps (server mode):** Having multiple workspaces of the same vaults open could result in bad timestamps
680
+
681
+ ### Documentation
682
+
683
+ ((ref:[[dendron.guides.troubleshooting]]#error upgrading:#*))
684
+
685
+ ## [0.12.8](https://github.com/dendronhq/dendron/compare/v0.12.8-alpha.2...v0.12.8) (2020-10-14)
686
+
687
+ ### Features
688
+
689
+ #### Really update time in frontmatter (server only)
690
+
691
+ Dendron notes have frontmatter with an **updated** field. This field is supposed to show you the time in milliseconds of when the document was last updated. Until today's update, this field did not actually change 😅
692
+
693
+ ```
694
+ id: 65b03213-d3d1-46c0-9881-a6280ed9bdeb
695
+ title: New
696
+ desc: ''
697
+ updated: 1602096212957
698
+ created: 1602096212957
699
+ ```
700
+
701
+ Today's update makes **updated** update!
702
+
703
+ ### Enhancements
704
+
705
+ - **support BuildPod command (server mode)**: build pod now works when server mode is enabled
706
+
707
+ ### Bug Fixes
708
+
709
+ - **navigating to special notes**: scratch/journal notes could fail to open if note already exists
710
+
711
+ ### Other
712
+
713
+ ((ref:[[dendron.topic.extensions]]#useful extensions))
714
+
715
+ ((ref:[[dendron.guides.tips]]#copy and paste web content into dendron:#*))
716
+
717
+ ((ref:[[dendron.guides.cook]]#mobile support:#*))
718
+
719
+ ## [0.12.7](https://github.com/dendronhq/dendron/compare/v0.12.7-alpha.10...v0.12.7) (2020-10-13)
720
+
721
+ ### Features
722
+
723
+ #### (Local) Server Side Indexing
724
+
725
+ Dendron can now index and manage your notes as a standalone **local** server independent from VSCode.
726
+
727
+ This is part of the [[server migration milestone|dendron.roadmap.project.n.2020.server-migration]] which we took on for October.
728
+
729
+ Dendron's server side indexing is a **complete rewrite** of the [[Dendron engine|dendron.dev.design.engine]] which powers Dendron's lookup capabilities. The new engine is **leaner, meaner, and significantly faster** (especially when initializing your workspace with a large amount of notes).
730
+
731
+ Server site indexing is a pre-cursor enables our upcoming roadmap items which include:
732
+
733
+ - [[multi-vault support|dendron.roadmap.project.n.2020.multi-vault]]
734
+ - rich graphical interfaces for schemas, pods, and publishing
735
+ - unified index for all dendron extensions (currently each extension makes a separate index of your notes and requires manual reloading)
736
+ - realtime updates for graph extensions
737
+ - custom dendron extensions written in any language
738
+
739
+ Server side indexing is currently off by default since it's still a beta feature. You can turn it on by adding the following in your settings.
740
+
741
+ ```json
742
+ "dendron.useExperimentalLSPSupport": true
743
+ ```
744
+
745
+ Note that the current commands are currently un-available when you switch on on server side indexing:
746
+
747
+ - RenameNote
748
+ - Refactor Hierarchy
749
+ - Archive Hierarchy
750
+ - Realtime Schema Updates
751
+ - Pod Commands
752
+
753
+ You can switch back to regular indexing at anytime by changing the above setting to `false` and running `> Developer: Reload Window`.
754
+
755
+ ### Enhancements
756
+
757
+ - **Additional Arguments for lookup**: You can now use `noConfirm` and `value` arguments when creating custom lookup shortcuts ([docs](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#passing-arguments-to-lookup))
758
+ - **Update Default Snippets**: default todo snippet now leaves a space after insertion
759
+ - **Set custom log levels**: you can now define the verbosity of dendron logs using the `dendron.logLevel` configuration
760
+ - **Upgraded Schema defaults** (server only): new schemas will be created using version one defaults
761
+ - **Cleaner note frontmatter** (server only): new notes won't have the optional attributes in frontmatter
762
+
763
+ ### Bug Fixes
764
+
765
+ - **Missing logs**: issue where `Open Logs` would not show logs
766
+ - **Tree View empty**: tree view would not populate in some cases
767
+ - **Upgrade Snippets with comments**: Upgrading settings would fail if they had comments inside the JSON
768
+
769
+ ### Breaking Changes
770
+
771
+ - **Remove Scratch Note Command**: replaced by Lookup Scratch Note shortcut
772
+ - **Remove Journal Note Command**: replaced by Lookup Journal Note shortcut
773
+
774
+ ### Progress
775
+
776
+ #### Server Migration
777
+
778
+ These past two weeks have been spent on server migration work. We are almost at the end and I'm aiming to have full coverage of all existing functionality by early next week.
779
+
780
+ ((ref:[[dendron.roadmap.project.n.2020.server-migration]]#tasks,1:#*))
781
+
782
+ ### Other
783
+
784
+ - Add overview of [[configuration|dendron.topic.config]]
785
+ - Add proposal for [[custom color tabs|dendron.roadmap.project.n.backlog.color-tabs]]
786
+
787
+ ## [0.12.6](https://github.com/dendronhq/dendron/compare/v0.12.5...v0.12.6) (2020-10-07)
788
+
789
+ ### Features
790
+
791
+ #### Default Snippets
792
+
793
+ Dendron now initializes your workspace with common default snippets
794
+
795
+ ((ref:[[dendron.topic.snippets]]#default snippets,1:#*))
796
+
797
+ #### Latex Support on Published Site
798
+
799
+ ((ref:[[dendron.pro.dendron-jekyll.topic.math]]#math,1:#*))
800
+
801
+ #### Introduce siteRepoDir Customization
802
+
803
+ ((ref:[[dendron.topic.publishing.configuration]]#siterepodir,1:#*))
804
+
805
+ ### Bug Fixes
806
+
807
+ - trying to publish the `dendron-template` no longer results in a missing links report
808
+ - issue with schemas not showing up under lookup
809
+
810
+ ### Progress
811
+
812
+ This section tracks our progress against the milestones in our [[public roadmap|dendron.roadmap]]
813
+
814
+ - [x] [[Seeds v0|dendron.roadmap.project.n.2020.seeds]]
815
+ - [ ] Server migration, progress: 70/100
816
+ ```
817
+ - below is a summary of our progress. we are currently about half way done
818
+ - aiming to have a workable version using the Dendron server by next week
819
+ ```
820
+ ((ref:[[dendron.roadmap.project.n.2020.server-migration]]#tasks,1:#*))
821
+
822
+ ### Other
823
+
824
+ #### Seeds
825
+
826
+ - We launched two [[seeds|dendron.topic.seeds]]. A seed is a dendron site that tries to be be a all encompassing reference for a particular vertical. Dendron provides specific libraries and CLIs that make it easy for users to create seeds from existing open source content as well as personal notes.
827
+
828
+ Current Seeds:
829
+
830
+ ```
831
+ - open PKM catalogue
832
+ - open AWS catalogue
833
+ ```
834
+
835
+ ((ref:[[dendron.community.showcase]]#open pkm catalogue,1:#*))
836
+ ((ref:[[dendron.community.showcase]]#open aws catalogue,1:#*))
837
+
838
+ #### Alternatives
839
+
840
+ this announcement also comes with an ask. Dendron is now in [AlternativesTo](https://alternativeto.net/), a crowdsourced catalogue for software recommendations. If you like Dendron and want to help us spread the word 🌱, please leave us a review [here](https://alternativeto.net/software/dendron/reviews/) 🙏
841
+
842
+ ## [0.12.4](https://github.com/dendronhq/dendron/compare/v0.12.4-alpha.11...v0.12.4) (2020-09-30)
843
+
844
+ ### Features
845
+
846
+ #### Live schema updates
847
+
848
+ - schema changes are now updated in realtime. no more `Reload Index`
849
+ - NOTE: this doesn't yet apply to `Show Schema Graph`. you'll still need to run `Reload Index` to see the changes in the graph
850
+
851
+ ### Enhancements
852
+
853
+ - **lookup:** special notes are now created via lookup ([da825a9](https://github.com/dendronhq/dendron/commit/da825a9d2b1ec10a3f9d3eac20db06448fe5344b))
854
+ - instead of being a separate command, journal and scratch notes are now created using the regular lookup interface
855
+ - new keybindings have been introduced to [map old commands to new style lookups](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#passing-arguments-to-lookup)
856
+ - `Create Journal Note` and `Create Scratch Note` still exist as commands but will be deprecated in the next minor release
857
+
858
+ - **lookup:** support lookups opening with a new split ([da825a9](https://github.com/dendronhq/dendron/commit/da825a9d2b1ec10a3f9d3eac20db06448fe5344b))
859
+
860
+ ((ref:[[dendron.topic.lookup]]#split toggle))
861
+
862
+ - **refs:** easier note ref selection([114ff87](https://github.com/dendronhq/dendron/commit/114ff87be04f8d746b0be28f7627ba0d1ec9b504))
863
+
864
+ Dendron will now recognize a header selection if you have any part of the header highlighted (vs needing to highlight the entire line)
865
+
866
+ ((ref:[[dendron.topic.commands]]#copy note ref:#*))
867
+
868
+ ### Documentation
869
+
870
+ - we published our public roadmap
871
+
872
+ ((ref:[[dendron.roadmap]]))
873
+
874
+ - changelog moved to dedicated [page](https://dendron.so/notes/9bc92432-a24c-492b-b831-4d5378c1692b.html)
875
+ - lookup menu docs
876
+ ((ref:[[dendron.topic.lookup]]#lookup menu:#*))
877
+
878
+ ### Community Highlights
879
+
880
+ - a new planter has appeared 🌲
881
+ ((ref:[[dendron.community.showcase]]#luke's second brain))
882
+
883
+ ## [0.12.3](https://github.com/dendronhq/dendron/compare/v0.12.3-alpha.16...v0.12.3) (2020-09-26)
884
+
885
+ ### Features
886
+
887
+ #### Bad Link Reports
888
+
889
+ When building your site by running `Dendron: Build Pod`, Dendron will generate a bad links report of all wiki-links that did not resolve. It will also update the links to point to a 404 page instead.
890
+
891
+ <a href="https://www.loom.com/share/91c4d7b023754b76b4d02519946603e0">
892
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/91c4d7b023754b76b4d02519946603e0-with-play.gif"> </a>
893
+
894
+ ### Enhancements
895
+
896
+ - **lookup:** lookup command accept args ([3e1fe8a](https://github.com/dendronhq/dendron/commit/3e1fe8a33344c3e79c1fb5bd758eaeab23b7fb9f))
897
+ - **publishing:** better 404 page ([e74c4a2](https://github.com/dendronhq/dendron/commit/e74c4a2c97197f5d43132be6ac9436ac91d9db8a))
898
+ - **plugin:** dramatically reduce extension bundle size ([22cfff8](https://github.com/dendronhq/dendron/commit/22cfff8398611f54f7a88d7e110aa9f9f602ad4e))
899
+
900
+ ## [0.12.2](https://github.com/dendronhq/dendron/compare/v0.12.2-alpha.0...v0.12.2) (2020-09-24)
901
+
902
+ ### Enhancements
903
+
904
+ - **refs:** support partial header selection ([6e35393](https://github.com/dendronhq/dendron/commit/6e35393fe2d321b8d708fe1efd40c1eb4ad304e3))
905
+
906
+ ### Bug Fixes
907
+
908
+ - **publishing:** incremental builds not setting correct links ([e3dedf5](https://github.com/dendronhq/dendron/commit/e3dedf52d79dede98041edc77a41966cc5d6e8b5))
909
+
910
+ ## [0.12.1](https://github.com/dendronhq/dendron/compare/v0.12.1-alpha.2...v0.12.1) (2020-09-22)
911
+
912
+ ### Features
913
+
914
+ #### Create scratch or journal notes via lookup
915
+
916
+ A journal note is a self contained note that is meant to track something over time. Examples of journals include recording **workout sessions**, making **meeting notes**, and keeping a **mood journal**.
917
+
918
+ To create a journal note, trigger a lookup and then click on the calendar icon.
919
+
920
+ <a href="https://www.loom.com/share/3c3ddc1dc63547cea8bf186bec31f71b">
921
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/3c3ddc1dc63547cea8bf186bec31f71b-with-play.gif"> </a>
922
+
923
+ A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{Y-MM-DD-HHHHmmss}`.
924
+
925
+ <a href="https://www.loom.com/share/2fd3042119124df8bb4592d8ffe6d708">
926
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/2fd3042119124df8bb4592d8ffe6d708-with-play.gif"> </a>
927
+
928
+ - **lookup:** support selection modifiers when creating special notes ([591c55f](https://github.com/dendronhq/dendron/commit/591c55f792ad8121d27af3a1c645ff9a2458f19c))
929
+
930
+ ### Enhancements
931
+
932
+ - **lookup:** support selection and note toggles ([70cf9eb](https://github.com/dendronhq/dendron/commit/70cf9ebc7a02cc5f256c2a1ffeec62f1bf1642b8))
933
+ - **refs:** better header selection ([ba9a4d9](https://github.com/dendronhq/dendron/commit/ba9a4d975b115e4cf8bc211f5e00f0557f26693b))
934
+ - **refs:** emit error when header not found ([5deb2d1](https://github.com/dendronhq/dendron/commit/5deb2d18160974bd035b3703715acc16d0dcb012))
935
+ - **publish:** configure repoDir via config ([fa838e4](https://github.com/dendronhq/dendron/commit/fa838e48bc5e33b8aa00d5aa954283c55af4d917))
936
+

Added: vault/dendron.release.changelog.1x.md

vault/dendron.release.changelog.1x.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ id: b7b8292e-18d2-4f28-91bf-036da5699b13
3
+ title: -01.x
4
+ desc: ''
5
+ updated: 1610397084793
6
+ created: 1610397084793
7
+ ---
8
+

Added: vault/dendron.release.changelog.early-seed.md

vault/dendron.release.changelog.early-seed.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: 3abd00eb-1c1e-4253-aaf5-dcbe20c21850
3
+ title: Early Seed
4
+ desc: ''
5
+ updated: 1614313385678
6
+ created: 1604539200840
7
+ published: true
8
+ nav_exclude: true
9
+ ---
10
+ ## 0.30.1
11
+
12
+ ### Features
13
+
14
+ #### Custom Pods
15
+
16
+ We now have custom pod support
17
+ ![[dendron.topic.pod.custom#summary,1:#*]]
18
+
19
+ If you are interested in developing your own publishing pod, you can docs to do so [[here|dendron.topic.pod.dev]]
20
+
21
+ #### Dev.to Pod
22
+
23
+ As an example of what you can do with a custom pod, we created the [[Dev.to Pod|dendron.pro.devto-pod]] which lets you publish your notes to dev.to
24
+
25
+ ### Enhancements
26
+
27
+ - backlinks in published sites
28
+
29
+ ![[dendron.topic.publishing.features#backlinks,1]]
30
+
31
+ ### Bug Fixes
32
+
33
+ - delete node sometimes fails in multi-vault
34
+ - publishing multi-vault will sometimes not work if multiple domain notes
35
+ - unable to select `root` of multi-vault notes in tree view
36
+
37
+ ### House Cleaning
38
+
39
+ - if you're working on the codebase, `dendron.code-workspace` has been renamed to `dendron-main.code-workspace`
40
+ - this helps if you're working on dendron while having dendron installed since Dendron, prior to this change, would also activate when you were editing the code
41
+

Added: vault/dendron.release.changelog.md

Files changed (1) hide show
  1. vault/dendron.release.changelog.md +606 -0
vault/dendron.release.changelog.md ADDED
@@ -0,0 +1,606 @@
1
+ ---
2
+ id: 9bc92432-a24c-492b-b831-4d5378c1692b
3
+ title: Changelog
4
+ desc: ''
5
+ updated: 1615242074818
6
+ created: 1601508213606
7
+ date: '2022-01-01'
8
+ ---
9
+
10
+ ## 0.31.3
11
+ ### Features
12
+ #### Changelogs
13
+ ![[dendron.topic.publishing.changelogs#summary,1:#*]]
14
+
15
+ ### House Cleaning
16
+ - all tests are now `jest style` tests
17
+
18
+ ## 0.31.2
19
+ ### Features
20
+
21
+ #### Custom Domain Names
22
+
23
+ Dendron now supports custom domain names for [[managed publishing|dendron.topic.managed-publishing]]. You can find docs [[here|dendron.topic.managed-publishing.quickstart#adding-a-custom-domain-via-cname]]. Note that this feature is currently limited to [[environmentalist|dendron.community.roles#environmentalist]] .
24
+
25
+ ### Enhancements
26
+ - Add paste link command ([[docs|dendron.topic.commands#paste-link]])
27
+ - don't throw fatal error on bad wikilink
28
+ - don't throw fatal error if `siteUrl` not set while in `dev`
29
+ - add remark-containers plugin [[docs|dendron.topic.config#usecontainers]]
30
+
31
+ ### Bug Fixes
32
+ - refs don't include children or backlinks
33
+ - clean `dendron.yml` after removing a vault
34
+
35
+ ## 0.31.1
36
+
37
+ ### Bug Fixes
38
+
39
+ - issue with mixed case file names
40
+
41
+ ## 0.31.0
42
+ ***
43
+ ## 0.30.2
44
+
45
+ ### Features
46
+
47
+ #### Cross Vault Links
48
+
49
+ ![[dendron://dendron-site/dendron.topic.links#cross-vault-links,1]]
50
+
51
+ ### Enhancements
52
+
53
+ - you can now add a workspace when adding a remote vault ([[docs|dendron://dendron-site/dendron.topic.commands#vault-add]])
54
+ - better block quotes ([[docs|dendron.topic.publishing.misc#blockquote]])
55
+ - better formatted backlinks on published pages
56
+ - backlinks display using note title instead of file names
57
+ - copy note commands will create a cross vault link when in multi-vault environment
58
+
59
+ ### Bug Fixes
60
+
61
+ - selecting non-primary root note in dendron tree
62
+ - bad backlinks created for home page
63
+ - issue with hierarchies for mixed case parents
64
+
65
+ ### Documentation
66
+
67
+ - new docs on using dendron for [[blogging|dendron.topic.publishing.blogging]]
68
+
69
+ ### House Cleaning
70
+
71
+ - table of contents on published sites is now a remark extension, header changed to `children`
72
+ - jekyll publishing has been renamed to `legacy publishing`
73
+ - lots of internal refactoring of code
74
+
75
+ ## 0.30.1
76
+
77
+ ### Features
78
+
79
+ #### Custom Pods
80
+
81
+ We now have custom pod support
82
+ ![[dendron.topic.pod.custom#summary,1:#*]]
83
+
84
+ If you are interested in developing your own publishing pod, you can docs to do so [[here|dendron.topic.pod.dev]]
85
+
86
+ #### Dev.to Pod
87
+
88
+ As an example of what you can do with a custom pod, we created the [[Dev.to Pod|dendron.pro.devto-pod]] which lets you publish your notes to dev.to
89
+
90
+ ### Enhancements
91
+
92
+ - backlinks in published sites
93
+
94
+ ![[dendron.topic.publishing.features#backlinks,1]]
95
+
96
+ ### Bug Fixes
97
+
98
+ - delete node sometimes fails in multi-vault
99
+ - publishing multi-vault will sometimes not work if multiple domain notes
100
+ - unable to select `root` of multi-vault notes in tree view
101
+
102
+ ### House Cleaning
103
+
104
+ - if you're working on the codebase, `dendron.code-workspace` has been renamed to `dendron-main.code-workspace`
105
+ - this helps if you're working on dendron while having dendron installed since Dendron, prior to this change, would also activate when you were editing the code
106
+
107
+ ## 0.29.2
108
+
109
+ ### Features
110
+
111
+ #### Experimental Nunjuck Templates
112
+
113
+ Extremely powerful templating capabilities with [[nunjuck templates|dendron.topic.markdown#nunjuck-templates]]
114
+
115
+ ### Enhancements
116
+
117
+ - better multi-vault defaults
118
+ - instead of keeping [[remote vaults|dendron.concepts#remote-vault]] under a special `repos` folder, you can now initialize them where ever you want
119
+ - better git defaults with new vaults
120
+
121
+ ### Bug Fixes
122
+
123
+ - support turning off pretty refs for dendron preview ([[docs|dendron.topic.config#useprettyrefs]])
124
+
125
+ ## 0.29.1
126
+
127
+ ### Enhancements
128
+
129
+ - private vaults ([[docs|dendron.topic.config#visibility]])
130
+ - popover 403 links ([[docs|dendron.topic.publishing.selective-publication#403-page]])
131
+ - standardize pod cli interface
132
+
133
+ ### Bug Fixes
134
+
135
+ - use builtin clipboard manager
136
+ - private wiki links render errors on published page
137
+
138
+ ### House Cleaning
139
+
140
+ - [issue labeling automation](https://github.com/dendronhq/dendron/pull/453)
141
+ - remove legacy publishing commands (BuildPod & Publish)
142
+
143
+ ## 0.28.1
144
+
145
+ ### Features
146
+
147
+ #### Managed Publishing (Early Preview)
148
+
149
+ The initial release comes with the ability to publish a dendron workspace under {username}.dendron.wiki.
150
+ Dendron takes care of configuring your domain and building your site.
151
+
152
+ After you connect your github repo with Dendron, we'll kick off the initial publication.
153
+ Every subsequent time you push to your repo, Dendron will automatically build your site with the latest changes.
154
+
155
+ At launch, we are supporting publishing from a connected github repo.
156
+ Instructions to get started are [[here|dendron.topic.managed-publishing.quickstart]]
157
+
158
+ ### Enhancements
159
+
160
+ - show last modified time for published sites ([[docs|dendron.topic.publishing.configuration#sitelastmodified-optional]])
161
+ - add option to configure human readable ts formatting ([[docs|dendron.topic.config#dendrondefaulttimestampdecorationformat]])
162
+ - smaller downloads when using publishing commands for the first time
163
+ - much faster publishing commands
164
+ - frontmatter can now be folded
165
+
166
+ ### Bug Fixes
167
+
168
+ - 11ty build issues
169
+ - dendron `move note` command can fail when parents are stubs
170
+ - preview can get out of sync with Dendron
171
+
172
+ ### House Cleaning
173
+
174
+ - dendron monorepo is now on yarn
175
+ - this results in 4x faster initial builds and 6x smaller bundle sizes when developing
176
+ - dendron-11ty is now merged into the dendron monorepo
177
+
178
+ If you currently have Dendron checked out, you can use the following instructions to migrate
179
+
180
+ ```sh
181
+ # get latest version
182
+ git pull
183
+
184
+ npm install -g yarn
185
+ # remove old node_modules
186
+ ./bootstrap/scripts/cleanup.sh
187
+ yarn bootstrap:bootstrap
188
+ yarn bootstrap:build
189
+
190
+ ```
191
+
192
+ ## 0.27.2
193
+
194
+ ### Features
195
+
196
+ - diagnostics report ([[docs|dendron.topic.commands#dendrondev-diagnostics-report]])
197
+
198
+ ![[dendron.topic.commands#dendrondev-diagnostics-report,1]]
199
+
200
+ ### Enhancements
201
+
202
+ - add path customization to build-site ([[docs|dendron.topic.cli#buildsitev2]])
203
+ - Add default description option to dendron config ([[docs|dendron.topic.publishing.configuration#description]])
204
+ - add config to publish multi-vault when adding vault ([[docs|dendron.topic.publishing.configuration#duplicatenotebehavior-optional]])
205
+
206
+ ### Bug Fixes
207
+
208
+ - build-site doesn't overwrite STAGE environment
209
+ - do not delete text when extracting non-vault text
210
+ - add new vaults to newline in .gitignore
211
+
212
+ ## 0.27.1
213
+
214
+ ### Bug Fixes
215
+
216
+ - server close error when building website for production
217
+
218
+ ## 0.26.1
219
+
220
+ ### Features
221
+
222
+ - move notes between vaults using the move note command ([[docs|dendron.topic.commands#move-note]])
223
+
224
+ ### Enhancements
225
+
226
+ - nicer 403 page on unpublished pages ([[docs|dendron.topic.publishing.selective-publication#403-page]])
227
+
228
+ ### Bug Fixes
229
+
230
+ - issue with daily journal notes not getting pretty titles
231
+ - ctrl hover over images will create a note
232
+ - when removing a note with empty parents, clean up empty parents
233
+
234
+ ## 0.25.3
235
+
236
+ ### Features
237
+
238
+ - mermaid diagram support when publishing ([[docs|dendron.topic.markdown#diagrams]])
239
+ - display note title as link ([[docs|dendron.topic.config#usenotetitleforlink]])
240
+
241
+ ### Enhancements
242
+
243
+ - use list of vaults when resolving duplicate notes ([[docs|dendron.topic.publishing.configuration#passing-multiple-vaults]])
244
+ - go to definition now works for `![[refs]]`
245
+ - [[Copy Note Link|dendron.topic.commands#copy-note-link]] now updates alias to header value when copying header
246
+
247
+ ### Bug Fix
248
+
249
+ - grammar issue with unpublished page notification
250
+
251
+ ### House Cleaning
252
+
253
+ - remove `sync_vault` as a step when building dendron for the first time
254
+
255
+ ## 0.25.2
256
+
257
+ ### Bug Fix
258
+
259
+ - issue with new vaults not having welcome note
260
+
261
+ ## 0.25.1
262
+
263
+ ### Bug Fix
264
+
265
+ - issue with md outline not showing
266
+
267
+ ## 0.24.2
268
+
269
+ ### Features
270
+
271
+ #### Site Build and Preview built-in to extension
272
+
273
+ You can now publish and build your notes without going to the command line ([[docs|dendron.topic.commands#site-build]])
274
+
275
+ ### Enhancements
276
+
277
+ - show progress bar when syncing graph
278
+ - show progress bar when installing node modules
279
+ - [[useFMTitle|dendron.topic.config#usefmtitle]] set to true by default
280
+ - add `.gitignore` to newly created workspace
281
+ - [[Copy Note Url|dendron.topic.commands#copy-note-url]] uses `siteUrl` as value for noteRef
282
+
283
+ ### Bug Fixes
284
+
285
+ - fix issues with nav capitalization
286
+ - fix dup items in nav
287
+ - windows site preview not cleaning up child processes
288
+ - fix note graph errors
289
+
290
+ ### Docs
291
+
292
+ - revamped publishing docs
293
+
294
+ ### House Cleaning
295
+
296
+ - jekyll based publishing is now deprecated
297
+ - [[dendron.copyNoteUrlRoot|dendron.topic.config#dendroncopynoteurlroot]] deprecated for `siteUrl`
298
+
299
+ ## 0.24.1
300
+
301
+ ### Features
302
+
303
+ ### Enhancements
304
+
305
+ - enable pass dict to config ([ccbc017](https://github.com/dendronhq/dendron/commit/ccbc0178cdc0399230a47e4ab1c90d345e447aeb))
306
+ - use enhanced filter when creating 403 links ([65afe8c](https://github.com/dendronhq/dendron/commit/65afe8c084d1a657e943edb3ef1b497f3fd97ea6))
307
+ - custom header support ([[docs|dendron.topic.publishing.configuration#customheaderpath-optional]])
308
+ - [[add custom headers|scratch.2021.01.12.085012.add-custom-headers]]
309
+ - google analytics support ([[docs|dendron.topic.publishing.configuration#ga_tracking-optional]])
310
+ - [[Multi Vault Edit on GitHub|dendron.scratch.2021.01.09.multi-vault-edit-on-github]]
311
+
312
+ ### Bug Fixes
313
+
314
+ - fix multi-vault breadcrump null issue
315
+ - fix windows build for site
316
+
317
+ ## 0.23.2
318
+
319
+ ### Features
320
+
321
+ ### Enhancements
322
+
323
+ - better 403 page ([[docs|dendron.topic.publishing.selective-publication#403-page]])
324
+ - spurious error message if user doesn't create note from not selecting a vault
325
+ - better default journal note titles
326
+
327
+ ### Bug Fixes
328
+
329
+ - issue publishing with subdomain
330
+ - some queries not being returned in multi-vault settings
331
+ - issue with noteRef mangling when using doctor
332
+
333
+ ### House Cleaning
334
+
335
+ - update on date format for journal and scratch notes to use [Luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
336
+
337
+ ## 0.23.1
338
+
339
+ - Dendron Markdown Preview: 0.10.18
340
+ - Dendron 11ty: 1.23.6
341
+
342
+ ### Features
343
+
344
+ #### Updated Note Ref Syntax
345
+
346
+ You can now do references to notes using `![[note]]` instead of `((ref: [[note]]))` syntax. To reference a header, use `![[note#foo]]`. This changes makes our note ref syntax more consistent with our wiki link syntax.
347
+
348
+ Note that the new ref syntax expects a [[sluggified|dendron.ref.terms#slug]] header. This is done automatically when you use the updated [[copy note ref|dendron.topic.commands#copy-note-ref]] command.
349
+
350
+ This change makes it possible to create a ref to a header with special characters.
351
+
352
+ The old syntax ref syntax will still work but should now be considered deprecated. We will release a `doctor` command to help you auto-upgrade from the old syntax to the new syntax in the coming week.
353
+
354
+ #### Frontmatter Variable Substitution
355
+
356
+ It is now possible to use variables defined in your note frontmatter inside your note. The syntax is `{{fm.VAR_NAME}}` where `VAR_NAME` is the name of your variable. The `fm` designates that you want to use a frontmatter variable.
357
+
358
+ <!--
359
+ #### Publishing V2 Integration with Plugin
360
+
361
+ You can now both build your notes for publication and preview it from inside vscode.
362
+
363
+ ![[dendron.topic.commands#site-build:#dev]]
364
+ -->
365
+
366
+ ### Enhancements
367
+
368
+ - `nav_exclude` property excludes from nav sider and table of contents ([[docs|dendron.topic.publishing.navigation#nav-exclude]])
369
+ - [[copy note ref|dendron.topic.commands#copy-note-ref]] command will use the new note ref syntax
370
+ - footnote support in preview and when publishing ([[docs|dendron.topic.markdown#footnotes]])
371
+
372
+ ### Bug Fixes
373
+
374
+ - spaces in wiki link not rendering in preview
375
+
376
+ ## 0.22.2
377
+
378
+ ### Enhancements
379
+
380
+ - better fuzzy search for lookup
381
+ - publishing v2 enhancements
382
+ - abbreviation support for 11ty publishing ([[docs|dendron.topic.markdown#abbreviation]])
383
+ - better note titles ([[docs|dendron.ref.titles]])
384
+ - shrink size of published page 10x
385
+ - fix left nav position of current active page
386
+ - ability to override output folder from CLI when building site
387
+ - don't throw error on code blocks that are unsupported by prismjs
388
+
389
+ ### Bug Fixes
390
+
391
+ - markdown preview delay in showing newly created notes
392
+ - `buildSiteV2` not connect to running workspace
393
+
394
+ ## 0.22.1
395
+
396
+ ### Features
397
+
398
+ - [[Collections|dendron.topic.publishing.collections]] support for 11ty
399
+ - publish blog like archives using Dendron
400
+ - CLI Based Doctor ([[docs|dendron.topic.cli#doctor]])
401
+ - run various tests to make your notes are healthy for the new year
402
+ - use frontmatter as title when publishing and in the preview ([[docs|dendron.topic.config#usefmtitle]])
403
+
404
+ ### Enhancements
405
+
406
+ - additional metadata tags for published pages
407
+ - support `noindex` option ([[docs|dendron.topic.publishing.configuration#noindex]])
408
+ - add anchor links to headers
409
+ - use note title for page title
410
+ - support [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] option
411
+ - support overriding [[output|dendron.topic.cli#buildsitev2]] in `buildSiteV2` command
412
+ - don't throw error if no syntax highlighter available for code block
413
+
414
+ ### Bug Fixes
415
+
416
+ - issue connecting to open workspace using CLI
417
+ - nav bar when publishing multiple hierarchies will show wrong expansion options
418
+
419
+ ## 0.21.2
420
+
421
+ ### Enhancements
422
+
423
+ - build-site command can connect to current running workspace ([[docs|dendron.topic.cli#connect-to-open-workspace]])
424
+ - support inline math when publishing
425
+ - support block math when publishing
426
+ - support rendering gfm inside note reference when publishing
427
+ - support anchor headings when publishing
428
+ - support relative links when publishing
429
+
430
+ ### Bug Fixes
431
+
432
+ - issue with displaying math in preview
433
+
434
+ ### House Cleaning
435
+
436
+ - the code highlighter has been changed from `prismjs` to `highligher.js`
437
+
438
+ ## 0.21.1
439
+
440
+ ### Enhancements
441
+
442
+ - add seo tags ([[docs|dendron.topic.publishing.configuration#seo-options]])
443
+ - enable edit on github link ([[docs|dendron.topic.publishing.configuration#github-options]])
444
+ - migrate all jekyll `_config.yml` settings to `dendron.yml`
445
+
446
+ ### Bug Fixes
447
+
448
+ - build-site errors when building from vaults without `asset folder`
449
+ - build-site error on certain operating systems
450
+ - build-site error on node version != 12
451
+
452
+ ### Docs
453
+
454
+ - [dendron.so](https://dendron.so) is now published using the new 11ty framework
455
+ - add [[publishing to github guide|dendron.topic.publishing.github]] using github actions
456
+
457
+ ## 0.20.2
458
+
459
+ ### Features
460
+
461
+ #### Publishing For Multi Vault
462
+
463
+ ![[dendron.topic.multi-vault#publishing:#*]]
464
+
465
+ ### Enhancements
466
+
467
+ - creating engine via cli also initializes meta files ([d72f097](https://github.com/dendronhq/dendron/commit/d72f097e63d1fda065ac7ad50f85bebe99d6da66))([[docs|dendron.topic.cli#launchengineserver]])
468
+ - remove github light theme from dendron bundle ([33d5708](https://github.com/dendronhq/dendron/commit/33d57086510cdaefbb8af8f72c945d6f5e02be5c))
469
+ - support [[note refs for multi-vault|dendron.topic.multi-vault#note-references]]
470
+ - support relative links in dendron preview ([[docs|dendron.topic.links#wiki-links]])
471
+ - further speed enhancements to publishing using 11ty resulting in another 5x improvement
472
+ - configure [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] from `dendron.yml`
473
+
474
+ ### Bug Fixes
475
+
476
+ - refactor hierarchy miss self referential links ([00b385d](https://github.com/dendronhq/dendron/commit/00b385dd0d13e5809da012bbc88388886012b837))
477
+ - reduce frequency of `engine not connecting` error when launching dendron preview
478
+
479
+ ### House Cleaning
480
+
481
+ - [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] is set to `true` by default (or when not set) when publishing using 11ty
482
+
483
+ ## 0.20.1
484
+
485
+ ### Publishing V2 (preview)
486
+
487
+ We've re-build publishing for Dendron from the ground up to be faster, better, and easier to use.
488
+
489
+ Besides for schemas, publishing has consistently been one of the hardest to use features in Dendron. Dendron currently publishes using [jekyll](https://jekyllrb.com/) using our own [template](https://github.com/dendronhq/dendron-jekyll). While this has served as well initially, slow compile times for large sites and difficulty of getting started has made it a growing pain point.
490
+
491
+ To address this, we've migrated our publishing stack to [11ty](https://www.11ty.dev/), a super fast javascript based static generator. This means much faster, and perhaps more importantly, easier publishing.
492
+
493
+ There's still some work left to integrate publishing into the Dendron plugin - meanwhile, you can take the new publishing workflow for a spin using the [[dendron cli|dendron.topic.cli]]
494
+
495
+ In order to to use the 11ty based publishing, initialize your workspace with the following commands.
496
+
497
+ ```bash
498
+ npm init -y
499
+ npm install @dendronhq/dendron-cli@latest
500
+ npm install @dendronhq/dendron-11ty@latest
501
+ ```
502
+
503
+ After you have your dependencies installed, build your your site using the following command.
504
+
505
+ ```bash
506
+ npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve
507
+ ```
508
+
509
+ This will both compile your site locally and make it available at `localhost:8080` for instant preview. When building your site locally, the pages will be build to `{wsRoot}/build/site`.
510
+
511
+ When you are ready to publish to github, make sure to change the stage to `prod`.
512
+
513
+ ```bash
514
+ npx dendron-cli buildSiteV2 --wsRoot . --stage prod
515
+ ```
516
+
517
+ This will build your site to the path specified by [[siteRootDir|dendron.topic.publishing-legacy.configuration#siterootdir]] in `dendron.yml`.
518
+
519
+ #### Benchmarks
520
+
521
+ Publishing V2 is ~10x faster than jekyll based publishing for sites with +100 pages. For comparison, below is the compilation difference between building the dendron site using 11ty vs jekyll.
522
+
523
+ - 11ty: 24.45s
524
+ - jekyll: 220.33s
525
+
526
+ There are additional optimizations still on the table that will further drive down he compilation time by another order of magnitude for future releases.
527
+
528
+ #### Gaps
529
+
530
+ 11ty publishing is currently not at full feature parity with Jekyll publishing. Notably, the following features are missing:
531
+
532
+ - setting a custom color theme
533
+ - `edit on github` links
534
+ - `jekyll-seo` functionality
535
+ - mathjax
536
+
537
+ #### Migration
538
+
539
+ All values that used to be written into `_config.yml` will now be moved into `dendron.yml`. You can see the currently supported configuration values here: `https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L71:L71`
540
+
541
+ If you currently have a Jekyll based Dendron page, note that the following settings have changed:
542
+
543
+ - the `url` property from `_config.yml` is now `siteUrl` in `dendron.yml`
544
+ - favicon is now controlled by `siteFaviconPath` in `dendron.yml` and is a path relative to your workspace root
545
+ - `CNAME` is now controlled by `githubCname` property in `dendron.yml`
546
+
547
+ #### Sample dendron.yml config
548
+
549
+ - publishing without a cname
550
+
551
+ ```yml
552
+ version: 1
553
+ vaults:
554
+ - fsPath: vault
555
+ site:
556
+ copyAssets: true
557
+ siteHierarchies:
558
+ - dendron
559
+ siteRootDir: docs
560
+ siteUrl: "kevinslin.github.io/dendron-11ty-test"
561
+ usePrettyRefs: true
562
+ ```
563
+
564
+ - using custom cname
565
+
566
+ ```yml
567
+ version: 1
568
+ vaults:
569
+ - fsPath: vault
570
+ site:
571
+ copyAssets: true
572
+ siteHierarchies:
573
+ - dendron
574
+ siteRootDir: docs
575
+ usePrettyRefs: true
576
+ siteUrl: "11ty.dendron.so"
577
+ githubCname: "11ty.dendron.so"
578
+ ```
579
+
580
+ #### Sample repo
581
+
582
+ - [github repo](https://github.com/kevinslin/dendron-11ty-test/deployments/activity_log?environment=github-pages)
583
+ - [github page](https://kevinslin.github.io/dendron-11ty-test/)
584
+
585
+ #### CLI Command Reference
586
+
587
+ ```bash
588
+ dendron-cli buildSiteV2
589
+
590
+ build notes for publication using 11ty
591
+
592
+ Options:
593
+ --version Show version number [boolean]
594
+ --help Show help [boolean]
595
+ --wsRoot location of workspace [required]
596
+ --vaults location of vault [array]
597
+ --serve serve over local http server [boolean] [default: false]
598
+ --stage serve over local http server
599
+ ```
600
+
601
+ <!-- https://hacks.mozilla.org/2020/10/to-eleventy-and-beyond/ -->
602
+
603
+ ## Past Releases
604
+
605
+ - [[0.1.X|dendron.release.changelog.0-1-x]]
606
+

Added: vault/dendron.release.md

Files changed (1) hide show
  1. vault/dendron.release.md +15 -0
vault/dendron.release.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: 932534e7-e788-4fdb-bc8c-eaf761992a8d
3
+ title: Releases
4
+ desc: ''
5
+ updated: 1610062266206
6
+ created: 1595984607503
7
+ stub: false
8
+ nav_order: 8
9
+ has_collection: true
10
+ sort_by: date
11
+ sort_order: reverse
12
+ expand_exclude: true
13
+ ---
14
+
15
+

Added: vault/dendron.rfc.1-dendron-nextjs.md

vault/dendron.rfc.1-dendron-nextjs.md ADDED
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: 17c61d62-f92e-4002-b8fe-9c05686e4bf9
3
+ title: "1 Dendron: Next Edition"
4
+ desc: ''
5
+ updated: 1615160650280
6
+ created: 1610911846754
7
+ ---
8
+
9
+ ## Why
10
+ - remove Markdown Preview Enhanced (MPE) dependency
11
+ - MPE has a huge surface area and we only use a small part of its feature set
12
+ - MPE is a sizable download (40mb) with performance issues on startup and a few other cases
13
+ - MPE is based on `markdown-it` whereas dendron is based on `remarkable`
14
+ - this makes our features sets incompatible and makes a lot of the MPE code base unsuitable for extension
15
+ - this also causes notes in the preview to render differently from code in the browser
16
+ - use next.js for markdown preview
17
+ - next.js is already used in Dendron webviews (eg. `Dendron: Configure`) and the plan is to convert all UI components to webviews
18
+ - next.js lets us add rich visualizations based on React and the latest web technologies
19
+ - next.js will let us eventually use MDX
20
+ - next.js can eventually be used as a scaffold for our own web client or dedicated desktop client
21
+
22
+ ## Goals with v1
23
+ - [ ] use next.js to do local preview of dendron notes
24
+
25
+ ### Stretch Goals
26
+ - [ ] scroll sync
27
+ - [ ] use next.js to preview dendron site
28
+ - [ ] better preview for schemas
29
+
30
+ ### Additional Features
31
+ - [ ] folding of headers
32
+
33
+ ## Future Goals
34
+ - use next.js to provide WYSWYG experience for dendron notes
35
+ - incorporate native lookup inside Dendron
36
+
37
+ ## Considerations
38
+ - we currently render notes into HTML for publication with 11ty. it seems like duplicate effort to re-create this in next.js
39
+ - ideally, want to either serve the static assets from 11ty using next.js or use next.js to generate the static assets
40
+ - kevin's thoughts: I like to be able to use next.js for everything down the line (static site generation + preview) but it might make more sense presently to implement a vscode specific preview and then figure out how to merge 11ty and next.js afterwards
41
+ - Dendron currently uses express as a backend
42
+ - we generate static assets from next.js at compile time using `next export` and then serve them over express
43
+ - Moving forward, if we want to use next.js for preview generation, we will probably need to swap out express with next.js
44
+ - reason we currently have the next.js/express split is because `next dev` dynamically re-compiles each route one at a time which causes our integration tests to fail (our integration tests call on the APIs from express ) and next.js causes the initial call to fail
45
+ - we'll need to either find a workaround in next.js our use next.js [custom server functionality](https://nextjs.org/docs/advanced-features/custom-server) to embed express
46
+ - kevin's thought: use custom server functionality. we'll lose out on some next.js code splitting features but should give us the best of both worlds otherwise
47
+
48
+ ## Tasks
49
+ - [ ] bundle next.js with dendron using custom router
50
+ - [ ] add api to dendron engine to preview a note
51
+ - [ ] update `Dendron: Show Preview` command to call API with current note
52
+
53
+ ## Related
54
+
55
+ - [Code for rendering webview currently](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/ConfigureWithUI.ts#L6:L6)

Added: vault/dendron.rfc.2-managed-publishing.md

vault/dendron.rfc.2-managed-publishing.md ADDED
@@ -0,0 +1,49 @@
1
+ ---
2
+ id: ae4a0c98-e2ea-47e0-8a20-016eba3424be
3
+ title: 2 Managed Publishing
4
+ desc: ''
5
+ updated: 1615160645832
6
+ created: 1611853430165
7
+ ---
8
+
9
+ ## Goal
10
+
11
+ Make it easy for everyone to publish a [digital garden](https://www.kevinslin.com/notes/30a9ec3e-d58f-44ce-8d7c-535f122f7d0b.html)
12
+
13
+ ## Tenants
14
+ - publishing should be accessible to everyone
15
+
16
+ ## Product
17
+
18
+ Provide a [netlify](https://www.netlify.com/) like service focused solely on Dendron based content.
19
+
20
+ This service will let you selectively publish your notes using Dendron itself without having to configure a third party host like netlify or github pages.
21
+ Pages will be hosted and published using [AWS](aws.amazon.com/) and will be [deployed globally](https://aws.amazon.com/cloudfront/features/) across the AWS edge network.
22
+
23
+ Your published page will have its own subdomain under `{username}.dendron.wiki`. We'll add support for custom domains early February as well.
24
+
25
+ ## Features
26
+ - [x] publish to dendron subdomain
27
+ - [x] SSL certs
28
+ - [x] global deployments using [worldwide CDN](https://en.wikipedia.org/wiki/Content_delivery_network)
29
+ - [x] github based publishing
30
+
31
+ ## Upcoming Features
32
+ - [ ] custom domain names
33
+ - [ ] protect published notes with a username/password
34
+ - [ ] whitelist individuals by email when sharing published notes
35
+ - [ ] create a secure link to a page (could be published or not-published)
36
+ - [ ] get detailed analytics for a page
37
+ - [ ] support comments underneath the page
38
+ - **{your suggestion here}**
39
+
40
+ ## Pricing
41
+ - Publishing one public workspace will be free.
42
+ - Publishing with additional features will have a nominal monthly fee with tiered pricing depending on feature set
43
+
44
+ ## FAQ
45
+
46
+ ### What if I want to publish using my own provider?
47
+
48
+ Dendron generates static assets and you'll always be able to publish using any host that can serve static content (aka all of them). Dendron managed publishing is about giving users a simplified one click solution to selectively publish notes that is maintained to be always up to date with the latest Dendron release.
49
+

Added: vault/dendron.rfc.2-managed-publishing.ref.github-token.md

vault/dendron.rfc.2-managed-publishing.ref.github-token.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ id: e0e854eb-ed78-4a98-8a95-5120426b7a1d
3
+ title: GitHub Token
4
+ desc: ''
5
+ updated: 1613063569227
6
+ created: 1613062854778
7
+ ---
8
+
9
+
10
+ 1. Create a new [personal access token](https://github.com/settings/tokens/new)
11
+ 2. Check the following boxes
12
+ ![](/assets/images/2021-02-11-09-11-49.png)
13
+ 3. Copy you access token
14
+ ![](/assets/images/2021-02-11-09-12-42.png)

Added: vault/dendron.rfc.2-managed-publishing.ref.md

vault/dendron.rfc.2-managed-publishing.ref.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 8f3f56fe-e45c-41d8-a8f0-f21f822b4877
3
+ title: Ref
4
+ desc: ''
5
+ updated: 1613444021667
6
+ created: 1613444021668
7
+ stub: true
8
+ ---
9
+

Added: vault/dendron.rfc.4-link-templates.md

vault/dendron.rfc.4-link-templates.md ADDED
@@ -0,0 +1,71 @@
1
+ ---
2
+ id: 7117a023-f090-47f5-a104-5968fc256c23
3
+ title: 4 Richer Templating
4
+ desc: ''
5
+ updated: 1615160638029
6
+ created: 1613929636812
7
+ ---
8
+
9
+ ## Goals
10
+
11
+ More powerful templating features for Dendron
12
+
13
+ ## Details
14
+
15
+ ## Proposal
16
+
17
+ Use [nunjucks](https://mozilla.github.io/nunjucks/) to customize Dendron
18
+
19
+ ### Example
20
+
21
+ - overriding properties in a link
22
+ ```
23
+ {{ ![[foo]] | config(prettyRef = false) }}
24
+ ```
25
+
26
+ - rendering a note ref with a custom template
27
+ ```
28
+ {{ ![[people.john]] | template("person") }}
29
+ ```
30
+ - raw note
31
+ ```
32
+ ---
33
+ title: John Snow
34
+ homepage: https://john.dendron.wiki
35
+ discord: @john123
36
+ email: john@hey.me
37
+ ---
38
+ ```
39
+
40
+ - template
41
+ ```
42
+ {% block content %}
43
+
44
+ # [{{fm.title}}]({{fm.homepage}})
45
+
46
+ - discord: {{fm.discord}}
47
+ - email: {{fm.email}}
48
+
49
+ {% endblock %}
50
+ ```
51
+
52
+ - output
53
+ ```md
54
+ # [John Snow](https://john.dendron.wiki)
55
+
56
+ - discord: @john123
57
+ - email: john@hey.me
58
+
59
+ ```
60
+
61
+
62
+
63
+ ## Tradeoffs
64
+ - pros
65
+ - cons
66
+ - slow down compilation time
67
+
68
+ ## Related
69
+
70
+ ## People
71
+ - [[Tmss|people.tmss]]

Added: vault/dendron.rfc.5-publishing-registry.md

vault/dendron.rfc.5-publishing-registry.md ADDED
@@ -0,0 +1,66 @@
1
+ ---
2
+ id: 21b2e152-95f7-4904-8a8e-8d4d0b8c950c
3
+ title: 5 Publishing Registry
4
+ desc: ''
5
+ updated: 1614550954834
6
+ created: 1614183727211
7
+ ---
8
+
9
+ ## Goals
10
+
11
+ Make it possible to discover, link, and build upon other published digital gardens.
12
+
13
+ ## Tenants
14
+ - extensible
15
+ - accessible
16
+ - interoperable
17
+
18
+ ## Use Cases
19
+ - link to and from other gardens with automatic reference tracking and citations
20
+ - discovery of gardens based on topics and interests
21
+
22
+ ## Proposal
23
+
24
+ Create both a spec and an initial implementation of the spec to keep a registry of digital gardens.
25
+
26
+ - Metadata for Garden:
27
+ - url: domain
28
+ - updated: epoch, last updated
29
+ - created: epoch, created
30
+ - author: name of author
31
+ - author.email: email of author
32
+ - linksTo: all gardens that this one links to, updated during upload
33
+ - linksFrom: all gardens that link to the current page, dynamically calculated and cached
34
+ - schemas: list of [[Schemas|dendron.topic.schema]] adopted by the garden
35
+ - tags: list of tags
36
+ - license: license for garden
37
+ - host: hosting platform
38
+
39
+ - Metadata for individual page:
40
+ - should be similar to that of garden
41
+
42
+ ## Example
43
+ ```
44
+ curl ENDPOINT/gardens/{username}/{gardenName}
45
+
46
+ url: dendron.so
47
+ tags: [pkm, vscode, note-taking]
48
+ updated: 1614184037
49
+ created: 1614182037
50
+ primaryAuthor: Kevin Lin
51
+ linksFrom:
52
+ - kiran/homepage
53
+ - nikita/homepage
54
+ - ...
55
+ linksTo:
56
+ - dendronhq/pkm
57
+ host:
58
+ type: git
59
+ url: https://github.com/dendronhq/dendron-site.git
60
+ scope: public
61
+
62
+ ```
63
+
64
+ ## Tradeoffs
65
+
66
+ - TBD

Added: vault/dendron.rfc.md

Files changed (1) hide show
  1. vault/dendron.rfc.md +8 -0
vault/dendron.rfc.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ id: f143ca38-dcc6-4cd3-b84b-997aec1160ef
3
+ title: Rfc
4
+ desc: ''
5
+ updated: 1610911876863
6
+ created: 1605539111635
7
+ ---
8
+

Added: vault/dendron.roadmap.md

Files changed (1) hide show
  1. vault/dendron.roadmap.md +44 -0
vault/dendron.roadmap.md ADDED
@@ -0,0 +1,44 @@
1
+ ---
2
+ id: 6e4c4f61-80a3-46fa-9ad3-04b99d9e9695
3
+ title: Project Public Roadmap
4
+ desc: ''
5
+ updated: 1614538364450
6
+ created: 1600840127160
7
+ stub: false
8
+ nav_order: 2.1
9
+ nav_exclude: true
10
+ ---
11
+ The Dendron Public Roadmap is a list of all the things we're working on for the year.
12
+
13
+ You can see the corresponding issues on [github](https://github.com/orgs/dendronhq/projects/1) where you can leave comments and feedback. You can also comment in our [#feedback](https://discord.gg/mxvczE9) channel on discord.
14
+
15
+ # Legend
16
+
17
+ - `[x]`: done
18
+ - \#wip: work in progress
19
+ - \#feedback: actively looking for feedback
20
+
21
+ ## Epics
22
+
23
+ - September
24
+ - [x] [[principles and values|dendron.roadmap.project.n.2020.principles-and-values]]
25
+ - [ ] [[pods v0|dendron.roadmap.project.n.2020.pods]]
26
+ - [x] [[seeds v0|dendron.roadmap.project.n.2020.seeds]]
27
+ - October
28
+ - [x] [[Server Migration|dendron.roadmap.project.n.2020.server-migration]] #wip
29
+ - [x] [[Quality of Life Improvements v0|dendron.roadmap.project.n.2020.qol]] #feedback #wip
30
+ - November
31
+ - [ ] [[Multi Vaults|dendron.roadmap.project.n.2020.multi-vault]] #wip
32
+ - [ ] [[Long Term Sustainability v0|dendron.roadmap.project.n.2020.long-term-sustainability]]
33
+ - December
34
+ - [ ] [[Git all the people|dendron.roadmap.project.n.2020.git]]
35
+ - [ ] [[Power Functionality v0|dendron.roadmap.project.n.2020.power-functionality]]
36
+
37
+ ## Long Lived Initiatives
38
+
39
+ These projects don't have an end date. They are something we'll continuously work towards.
40
+
41
+ - [[Better Docs|dendron.roadmap.project.n.2020.better-docs]]
42
+ - [[Community Building|dendron.roadmap.project.n.2020.community-building]]
43
+ - [[Recruiting Gardeners|dendron.roadmap.project.n.2020.recruit-gardeners]]
44
+

Added: vault/dendron.roadmap.project.cook.md

vault/dendron.roadmap.project.cook.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ id: 3f63b02d-6385-45ad-b0b6-b797d221d714
3
+ title: Cookbook
4
+ desc: ''
5
+ updated: 1599504980338
6
+ created: 1599504980338
7
+ stub: false
8
+ ---
9
+ ## Access Dendron Repo issues inside VSCode (optional)
10
+
11
+ - this might require that you have vscode insiders
12
+
13
+ - this might be useful to do even if you don't plan on working on the code since it lets you interact with github issues from inside vscode
14
+
15
+ - [ ] checkout the [dendron repo](https://github.com/dendronhq/dendron)
16
+
17
+ - [ ] download [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension
18
+
19
+ ## Access Dendron Template issues inside VSCode (optional)
20
+
21
+ - follow same instruction as above (minus downloading the extension if you already have it installed)
22
+

Added: vault/dendron.roadmap.project.md

Files changed (1) hide show
  1. vault/dendron.roadmap.project.md +75 -0
vault/dendron.roadmap.project.md ADDED
@@ -0,0 +1,75 @@
1
+ ---
2
+ id: 8cf880da-6402-47fb-8e9a-9d5fa38e31d0
3
+ title: Project
4
+ desc: ''
5
+ updated: 1609269445117
6
+ created: 1599498964153
7
+ stub: false
8
+ ---
9
+ This hierarchy describes the short term and long term projects of Dendron.
10
+
11
+ ## Q4 2020
12
+
13
+ - [[Principles and Values|dendron.roadmap.project.n.2020.principles-and-values]]
14
+ - [[Pods|dendron.roadmap.project.n.2020.pods]]
15
+ - [[The Seed Bank|dendron.roadmap.project.n.2020.seeds]]
16
+ - [[Recruit Gardeners|dendron.roadmap.project.n.2020.recruit-gardeners]]
17
+ - [[Quality of Life Improvements|dendron.roadmap.project.n.2020.qol]]
18
+ - [[Dendron Language Server Protocol|dendron.roadmap.project.n.2020.server-migration]]
19
+ - [[Multi-Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
20
+ - [[Community Building|dendron.roadmap.project.n.2020.community-building]]
21
+ - [[Power Functionality|dendron.roadmap.project.n.2020.power-functionality]]
22
+ - [[Better Docs|dendron.roadmap.project.n.2020.better-docs]]
23
+ - [[Git All The People|dendron.roadmap.project.n.2020.git]]
24
+ - [[Long Term Sustainability|dendron.roadmap.project.n.2020.long-term-sustainability]]
25
+
26
+ ## Commenting and Reviews
27
+
28
+ ### For Dendrologists
29
+
30
+ The easiest way to leave a comment is by using the [code stream extension](https://marketplace.visualstudio.com/items?itemName=CodeStream.codestream).
31
+
32
+ You should have received an invite to be part of the **Dendrologist** team (if not, ping Kevin).
33
+
34
+ After you install the extension and log in, you'll be able to leave comments inline in the the docs!
35
+
36
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/project.code-stream.gif)
37
+
38
+ ## Other Resources
39
+
40
+ - [[Cookbook|dendron.roadmap.project.cook]]: Optional things to help you manage Dendron projects
41
+
42
+ # Structure
43
+
44
+ ## Custom Frontmatter
45
+
46
+ - start: start date for project
47
+ - end: end date for project
48
+
49
+ ## Snipets
50
+
51
+ - `project`: creates the outline for a new project
52
+
53
+ ## Sections
54
+
55
+ ```
56
+ ## Goals
57
+
58
+ What are we trying to accomplish. Try to limit this to one or two sentences.
59
+
60
+ ## Details
61
+
62
+ This can be used to further elaborate on the task at hand
63
+
64
+ ## Discussions
65
+
66
+ Link to existing discussion on the topic.
67
+
68
+ ## Tasks
69
+ What tasks are related to accomplish this project?
70
+
71
+ ## Release Notes
72
+
73
+ What does the public announcement of this project look like?
74
+ ```
75
+

Added: vault/dendron.roadmap.project.n.2020.better-docs.md

vault/dendron.roadmap.project.n.2020.better-docs.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: c8690c83-dae2-4d16-849a-555a25c5a57a
3
+ title: Better docs
4
+ desc: ''
5
+ updated: 1599501863528
6
+ created: 1599501863528
7
+ stub: false
8
+ ---
9
+ ## Goals
10
+
11
+ Improve Dendorn documentation for new comers and power users
12
+
13
+ ## Details
14
+
15
+ ## Tasks
16
+
17
+ ## Release Notes
18
+

Added: vault/dendron.roadmap.project.n.2020.community-building.md

vault/dendron.roadmap.project.n.2020.community-building.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: b01d9f1d-a289-412c-8e42-bbfac02ed843
3
+ title: Community building
4
+ desc: ''
5
+ updated: 1599501757503
6
+ created: 1599501757503
7
+ stub: false
8
+ ---
9
+ ## Goals
10
+
11
+ Grow the Dendron community while keeping the intimate and cozy atmosphere we have today
12
+
13
+ ## Details
14
+
15
+ ## Tasks
16
+
17
+ ## Release Notes
18
+

Added: vault/dendron.roadmap.project.n.2020.git.md

vault/dendron.roadmap.project.n.2020.git.md ADDED
@@ -0,0 +1,32 @@
1
+ ---
2
+ id: 37f3623c-d87e-4181-8531-2edb578d3391
3
+ title: Git All the People
4
+ desc: ''
5
+ updated: 1599577035289
6
+ created: 1599577035289
7
+ stub: false
8
+ start: 2020.12.07
9
+ end: 2020.12.16
10
+ status: Next
11
+ ---
12
+ ## Goals
13
+
14
+ Git+Dendron make an ideal workflow but this is currently hard and non-obvious to get started with, especially for non-programmers. Ideally, we should be able to integrate all the benefits of git (versions, blame annotations, log history, etc) without the end user even being aware that git is being used.
15
+
16
+ ## Details
17
+
18
+ TBD
19
+
20
+ ## Tasks
21
+
22
+ TBD
23
+
24
+ ## Next
25
+
26
+ TBD
27
+
28
+ ## Links
29
+
30
+ - [project docs](https://dendron.so/notes/37f3623c-d87e-4181-8531-2edb578d3391.html)
31
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.git)
32
+

Added: vault/dendron.roadmap.project.n.2020.long-term-sustainability.md

vault/dendron.roadmap.project.n.2020.long-term-sustainability.md ADDED
@@ -0,0 +1,71 @@
1
+ ---
2
+ id: d892da5f-3667-4bfe-a8ba-e5ea3da4eb72
3
+ title: Long term sustainability v0
4
+ desc: ''
5
+ updated: 1604945094990
6
+ created: 1599501881180
7
+ stub: false
8
+ start: 2020.10.07
9
+ end: 2020.11.29
10
+ status: Next
11
+ ---
12
+ ## Goals
13
+
14
+ Figure out and experiment with a long term business model for Dendron.
15
+
16
+ ## Details
17
+
18
+ [Kevin](https://github.com/kevinslin) is the founder of Dendron and working on it full time. He funds it by selling Amazon stock every couple of months. While this works for now, it will eventually hit a wall.
19
+
20
+ Kevin wants to work on Dendron full time for the forseeable future and would like to hire other people full time to do the same.
21
+
22
+ ## Tasks
23
+
24
+ - [x] come up with different revenue plans
25
+ - [x] launch the **environmentalist plan**
26
+ - re-curring payment to support development of Dendron
27
+ - access to special once a month zoom chat about features
28
+ - swag
29
+ - discord icon
30
+ - discount for server side features
31
+
32
+ ## Next
33
+
34
+ - server side features
35
+ - private hosting
36
+ - native sync
37
+ - server side pods (eg. everytime you add data to airtable, add an entry to Dendron)
38
+
39
+ ## Links
40
+
41
+ - [project docs](https://dendron.so/notes/d892da5f-3667-4bfe-a8ba-e5ea3da4eb72.html)
42
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.lts-v0)
43
+
44
+ ## Notes
45
+
46
+ ### Revenue Ideas
47
+
48
+ - pro status
49
+ - support dendron development using one time or recurring fee
50
+ - get a dendron sticker and special discord badge
51
+ - get discount when we launch sever feature rates
52
+ - workshops
53
+ - server features
54
+ - use **code-server** or something equivalent to run dendron inside a browser
55
+ - dedicated end2end sync
56
+ - hosted pods
57
+ - do daily import/export of notes from/to diff places
58
+ - dendron private catalogues
59
+ - give people the option to build a paying subscription base for their published notes (eg. substack)
60
+ - enterprise features
61
+ - active directory and support
62
+ - support remote mount point
63
+ - mobile app
64
+ - standalone client
65
+ - standalone dendron app
66
+ - maybe modified vscode (without coding)
67
+ - theia
68
+ - vscodium
69
+ - charge a pay what you can model?
70
+ - wyswg client
71
+

Added: vault/dendron.roadmap.project.n.2020.md

vault/dendron.roadmap.project.n.2020.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 58247dfb-55b4-4269-9b37-42a90a0045ef
3
+ title: '2020'
4
+ desc: ''
5
+ updated: 1600123491932
6
+ created: 1600123491932
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.n.2020.pods.md

vault/dendron.roadmap.project.n.2020.pods.md ADDED
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: b1dbd32d-ca87-4489-9ba0-01bf7928cba5
3
+ title: Pods v0
4
+ desc: ''
5
+ updated: 1603139155412
6
+ created: 1599499136050
7
+ stub: false
8
+ start: 2020.09.07
9
+ end: 2020.09.29
10
+ status: In Progress
11
+ ---
12
+ ## Goal
13
+
14
+ Make it possible for people to import/export their data between Dendron and **any other** platform that contains information a user might care about.
15
+
16
+ ## Details
17
+
18
+ Dendron wants to be your **central digital nervous system** - our end goal is to be the **best possible way** to create, build, use, and share the knowledge that matters to you.
19
+ To do that effectively, we believe its important that you have **full control of your information**. This means having your data available in plaintext markdown and having an note-taking tool that is local and open source. But we want to go further than that which is where [pods](TODO) come in.
20
+ Dendron refers to a pod as anything you could conceivably use to store/publish notes. Evernote, Roam, static websites, twitter - any and all of these things are potential pods. The vision with pods is that you should be able to seamlessly move **your information** in and out a pod and in and out of Dendron.
21
+
22
+ Unlike what the [notion](https://www.notion.so/) marketing folks might tell you, we don't believe there is a one size fits all approach when it comes to knowledge management, a concept that includes collecting articles, project management, journaling, collaboration, and basically any workflows that involve working with information.
23
+
24
+ While Dendron will make it possible for you to do these things, it will also help you move your information to tools that do it better for a given use case. Imagine being able to collaborate on a note using [google docs](https://docs.google.com/), use the spreadsheet functionality in [airtable](https://airtable.com/) to organize and all the while keep a canonical copy of that note inside Dendron where it is just a lookup away.
25
+
26
+ If you have ideas about pods and pod related workflows that you would like to see us build, please come discuss them with us in our newly created [#pods](https://discord.gg/8vjasHj) channel.
27
+
28
+ ## Tasks
29
+
30
+ - [x] establish basic pod framework
31
+ - [x] use pods via extension
32
+ - [x] use pods via CLI
33
+ - [x] create 2 pods
34
+ - [ ] support custom pods
35
+ - [ ] document pods
36
+
37
+ ## Next
38
+
39
+ - community voting on pods
40
+ - stabilize pod API
41
+
42
+ ## Links
43
+
44
+ - [project docs](https://dendron.so/notes/b1dbd32d-ca87-4489-9ba0-01bf7928cba5.html)
45
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.pods-v0)
46
+
47
+ ## Related
48
+
49
+ - [[dendron.topic.pod]]
50
+ - [[pod proposal issue|dendron.roadmap.project.scratch.2020.09.07-164009]]
51
+

Added: vault/dendron.roadmap.project.n.2020.power-functionality.md

vault/dendron.roadmap.project.n.2020.power-functionality.md ADDED
@@ -0,0 +1,33 @@
1
+ ---
2
+ id: ff1b9ea5-6d0e-49b2-97d1-a7e31299164e
3
+ title: Power functionality v0
4
+ desc: ''
5
+ updated: 1599501792934
6
+ created: 1599501792934
7
+ stub: false
8
+ start: 2020.12.07
9
+ end: 2020.12.15
10
+ status: Next
11
+ ---
12
+ ## Goals
13
+
14
+ Support power user functionality
15
+
16
+ ## Details
17
+
18
+ TBD
19
+
20
+ ## Tasks
21
+
22
+ - schemas
23
+ - [ ] [specify sections within notes](https://github.com/dendronhq/dendron/issues/248)
24
+
25
+ ## Next
26
+
27
+ TBD
28
+
29
+ ## Links
30
+
31
+ - [project docs](https://dendron.so/notes/ff1b9ea5-6d0e-49b2-97d1-a7e31299164e.html)
32
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.power-func-v0)
33
+

Added: vault/dendron.roadmap.project.n.2020.principles-and-values.md

vault/dendron.roadmap.project.n.2020.principles-and-values.md ADDED
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: 35d7d7bc-64a6-4850-9a54-7de7f43ad751
3
+ title: Principles and Values
4
+ desc: ''
5
+ updated: 1599499842665
6
+ created: 1599499842665
7
+ stub: false
8
+ start: 2020.09.07
9
+ end: 2020.09.20
10
+ status: Done
11
+ ---
12
+ ## Goals
13
+
14
+ Come up with governing principals and values for the Dendron product and the Dendron Community. This item is complete and documented under [[dendron.principles]]
15
+
16
+ ## Details
17
+
18
+ ### Product Principles
19
+
20
+ - speed: Dendron should be the fastest way for **people** to access the information they care about
21
+ - lookup should finish in under a second
22
+ - all parts of our toolchain should optimize for speed
23
+ - ownership: users should have **full control** of their data and it should be our first principle to maximize this as much as possibility
24
+ - interoperability: it should be possible to import/export your data from/to any other source where a user might want to use their information
25
+ - easy to learn, hard to master: see [Bushnell's Law
26
+ ](https://en.wikipedia.org/wiki/Bushnell%27s_Law#:~:text=Bushnell's%20Law%20or%20Nolan's%20Law,first%20quarter%20and%20the%20hundredth.)
27
+
28
+ ### Community Values
29
+
30
+ - open and inclusive: Dendron is a tool for **all users** that are interested in creating, building, using, and sharing knowledge. full stop.
31
+ - documentation first: we don't just share what we learn in a chat at a moment in time. we make sure that the information remains accessible longer after we are gone. we do this by documenting useful information in [dendron](http://dendron.so/)
32
+ - have it in writing
33
+
34
+ ### Tradeoffs
35
+
36
+ You can't have something that is everything for everyone. While both characteristics matter, we agree to make these tradeoffs when necessary.
37
+
38
+ - function over form
39
+ - in dendron, its more important for something to be useful than it is to be beautiful
40
+ - the focus in dendron should be about your content and the hierarchies that connect them
41
+ - focus on speed
42
+ - we can't predict the future but its likely that no one will ever say that they wish their note taking experience to be slower
43
+ - when thinking about features and tool chain, bias for speed
44
+ - focus on hierarchies
45
+ - while dendron supports backlinks and other forms of organizing notes, dendron's foundation is tooling to help you manage hierarchies
46
+ - retrieval over insertion @kpathakota
47
+
48
+ ## Related
49
+
50
+ - [[dendron.principles]]
51
+

Added: vault/dendron.roadmap.project.n.2020.qol.md

vault/dendron.roadmap.project.n.2020.qol.md ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: c4cb56af-ec13-4e57-aede-eb341e870736
3
+ title: Quality of Life Improvements (QoL) v0
4
+ desc: ''
5
+ updated: 1599501500764
6
+ created: 1599501500764
7
+ stub: false
8
+ start: 2020.10.07
9
+ end: 2020.10.29
10
+ status: Next
11
+ ---
12
+ ## Goals
13
+
14
+ Dendron is many things but easy to use it is not quite (yet).
15
+
16
+ ## Details
17
+
18
+ Make Dendron easy to onboard (even for non-technical users) and smooth some of the rough edges.
19
+
20
+ ## Tasks
21
+
22
+ - [x] collect feedback from the community
23
+ - [ ] support anchor based markdown links
24
+ - [ ] [easier schema creation](https://github.com/dendronhq/dendron/issues/249)
25
+ - [ ] easier note publication
26
+ - [ ] improve initial onboarding
27
+ - [ ] update note metadata in realtime
28
+ - [ ] show graph view of backlinks (in addition to hierarchies)
29
+
30
+ ## Next
31
+
32
+ - interactive tutorial?
33
+ - support folders
34
+
35
+ ## Links
36
+
37
+ - [project docs](https://dendron.so/notes/c4cb56af-ec13-4e57-aede-eb341e870736.html)
38
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.qol-v0)
39
+

Added: vault/dendron.roadmap.project.n.2020.recruit-gardeners.md

vault/dendron.roadmap.project.n.2020.recruit-gardeners.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 750c86bc-9b72-46b5-9c08-865af1bed622
3
+ title: Recruit Gardeners
4
+ desc: ''
5
+ updated: 1599501257121
6
+ created: 1599501257121
7
+ stub: false
8
+ ---
9
+ ## Goals
10
+
11
+ Recruit additional gardeners (aka developers) that will help build Dendron for the long haul.
12
+
13
+ ## Details
14
+
15
+ Dendron has an ambitious roadmap and a community with an unquenchable thirst for better ways of working with their information. These are all good things. That being said, the head gardener (Kevin) is stretched a little thin at the moment trying to do all these things and would benefit from having a few helping hands when it comes to developing features.
16
+

Added: vault/dendron.roadmap.project.n.2020.seeds.md

vault/dendron.roadmap.project.n.2020.seeds.md ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: b81810f7-4d47-4870-ad2c-d4e48a49aa22
3
+ title: Seeds v0
4
+ desc: ''
5
+ updated: 1599498995178
6
+ created: 1599498995178
7
+ stub: false
8
+ start: 2020.09
9
+ end: 2020.09.19
10
+ status: Done
11
+ ---
12
+ ## Goal
13
+
14
+ Make it easy for people to publish and find high quality notes for any topic they care about
15
+
16
+ ## Details
17
+
18
+ Dendron lets anyone publish an online version of the notes inside their Dendron vault. The [Dendron Website](https://dendron.so/) is an example of a published vault.
19
+
20
+ Dendron seeds is a project to to curate notes from existing open source material. This means re-mixing existing open source content into public references. For example, [og-aws](https://github.com/open-guides/og-aws) is a fantastic resource for AWS. [TLDR](https://github.com/tldr-pages/tldr) is a great reference for CLI. The former is only available as a README, the latter via the console. It should be easy to take the content from these sites and publish them as public Dendron vaults. The information in these vaults can also be enriched from other sources. In this way, Dendron can help build the highest quality, most up to date, information for any respective domain that people care about.
21
+
22
+ ## Tasks
23
+
24
+ - [x] establish basic seed framework
25
+ - [x] populate seeds using CLI
26
+ - [x] create ~~3~~ 2 seeds in 3 ~~2~~ different verticals #wip
27
+ - [x] aws
28
+ - [x] open pkm
29
+
30
+ ## Next
31
+
32
+ - use seeds from within the dendron extension
33
+ - automatically keep seeded vaults up to date
34
+ - create index of high quality seeds
35
+
36
+ ## Links
37
+
38
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.seeds-v0)
39
+

Added: vault/dendron.roadmap.project.n.2020.server-migration.md

vault/dendron.roadmap.project.n.2020.server-migration.md ADDED
@@ -0,0 +1,221 @@
1
+ ---
2
+ id: 725d99be-fadd-4464-88c3-0a5fcc7292c7
3
+ title: Server Migration
4
+ desc: ''
5
+ updated: 1603982170477
6
+ created: 1599501616541
7
+ stub: false
8
+ start: 2020.09.23
9
+ end: 2020.10.30
10
+ status: In Progress
11
+ ---
12
+ ## Goals
13
+
14
+ Migrate the Dendron to (local) client &lt;-> server architecture
15
+
16
+ ## Details
17
+
18
+ Dendron's current architecture can be found [here](https://dendron.so/notes/c160ddce-edec-4f6e-841b-418d6030fa37.html). Currently, all of Dendron's indexing capabilities is provided by the `dendron engine` as a library which is included in every extension that uses it. This has many drawbacks - every extension re-indexes all notes and also blocks the client (vscode) during this process.
19
+
20
+ The Dendron server migration is to move Dendron to a client server architecture. Note that the migration will involve standing up **two servers**: one for language server functionality (the lsp server), and another for dendron's [lookup](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html) capabilities (the express server).
21
+
22
+ The rationale for having two servers is discussed [here](https://discordapp.com/channels/717965437182410783/748936364283920495/759153642644701285).
23
+
24
+ They are also elaborated upon [here](https://discordapp.com/channels/717965437182410783/735365126227493004/765435624878505985)
25
+
26
+ Instead of calling the engine directly, the Dendron extension, as well as related plugins, will communicate to Dendron's server using IPC and on local ports.
27
+
28
+ ## Tasks
29
+
30
+ - [x] add LSP server to Dendron (0.12)
31
+ - [x] add api server to Dendron (0.12)
32
+ - [x] hook server into dendron startup (0.12.4)
33
+ - [x] migrate lookup to server model
34
+ - [x] support query notes (0.12.6)
35
+ - [x] support query notes with schema (0.12.6)
36
+ - [x] support write notes (0.12.6)
37
+ - [x] support write note with schema (0.12.6)
38
+ - [x] support delete note (0.12.7)
39
+ - [x] support query schema (0.12.7)
40
+ - [x] support write schema (0.12.7)
41
+ - [x] support delete schema (0.12.7)
42
+ - [x] optimize server lookup performance (0.12.7)
43
+ - [x] enable file watcher (0.12.7)
44
+ - [x] dendron tree view (0.12.7)
45
+ - [x] migrate commands
46
+ - [x] scratch note (0.12.7)
47
+ - [x] journal note (0.12.7)
48
+ - [x] copy note command (0.12.7)
49
+ - [x] copy note url (0.12.7)
50
+ - [x] lookup scratch note (0.12.7)
51
+ - [x] lookup journal note (0.12.7)
52
+ - [x] global journal note (0.12.7)
53
+ - [x] build pod (0.12.8)
54
+ - [x] rename note
55
+ - [x] archive hierarchy
56
+ - [x] refactor hiearchy
57
+ - [x] doctor
58
+ - [x] integration tests for all server functionality
59
+
60
+ ## Next
61
+
62
+ - migrate bundled extensions to server model
63
+ - use custom goto definition provider
64
+ - use custom backlink definition provider
65
+ - use schema based completions
66
+
67
+ ## Configuration
68
+
69
+ To enable server mode, update the following setting in your workspace settings `"dendron.useExperimentalLSPSupport": true`. Run `> Developer: Reload Window` afterwards for the changes to take effect.
70
+
71
+ ## Links
72
+
73
+ - [project docs](https://dendron.so/notes/725d99be-fadd-4464-88c3-0a5fcc7292c7.html)
74
+ - [issues](https://github.com/dendronhq/dendron/labels/pro.server-migration)
75
+
76
+ ## Related
77
+
78
+ - [[dendron.topic.pod]]
79
+ - [[pod proposal issue|dendron.roadmap.project.scratch.2020.09.07-164009]]
80
+
81
+ <!--
82
+ ### Breakdown
83
+
84
+ - create `@dendronhq/lsp-server` package
85
+ - create interface btw lsp -> engine
86
+ - implement a basic **new** feature using lsp (eg. hover preview of link) and delegate to lsp
87
+ - route basic **old** feature to lsp (eg. go to definition from markdown-notes)
88
+ - everything else
89
+
90
+ ### Design
91
+ - components
92
+ - [[p.dendron-extension]]: vscode extension
93
+ - [[p.engine-v0]]: current dendron engine
94
+ - [[p.engine-server]]: dendron lsp engine
95
+ - [[p.engine-client]]: dendron lsp client
96
+ - concepts
97
+ - all links: note refs, wiki links, md links
98
+ - architecture today:
99
+ - [[p.dendron-extension]] -> [[p.engine-v0]]
100
+ - architecture after migration
101
+ - user commands: [[p.dendron-extension]] -> [[p.engine-client]] -> [[p.engine-server]]
102
+ - lsp specific actions: vscode -> [[p.engine-server]]
103
+
104
+ ### Challenges
105
+
106
+ #### Non-lsp functionality
107
+ LSP provides language specific features but doesn't provide us with the equivalent of [[dendron.topic.lookup]]. If we want to consolidate the indexing inside [[p.engine-server]], we need a way to query the index via [[p.engine-client]]. Below are a few proposals to do this:
108
+
109
+ 1. Write all metadata to JSON file. Use filewatcher for engine-client to watch the JSON file
110
+ 2. Add a custom listener to [[p.engine-server]] that listens for special [[p.engine-client]] requests on a standalone port
111
+
112
+ ### Flows
113
+
114
+ #### initialization
115
+ - user activates dendron workspace
116
+ - activates [[p.engine-server]] and [[p.engine-client]]
117
+ - [[p.engine-server]] indexes all files in workspace and sets file watcher to watch for changes
118
+ - [[p.engine-client]] gets notified when indexing is complete
119
+
120
+ #### sync
121
+ - [[p.engine-server]] will track the following changes
122
+ - frontmatter updates
123
+ - note updates
124
+ - schema updates
125
+ - dendron specifc config
126
+
127
+ #### commands
128
+
129
+ This describes what will be the main provider of the functionality that is currently done via the engine.
130
+
131
+ - Create Daily Journal Note
132
+ - provider: [[p.engine-client]]
133
+ - Create Journal Note
134
+ - provider: [[p.engine-client]]
135
+ - Create Scratch Note
136
+ - provider: [[p.engine-client]]
137
+ - Copy Note Link
138
+ - provider: [[p.engine-client]]
139
+ - Copy Note Ref
140
+ - provider: [[p.engine-client]]
141
+ - Delete Node
142
+ - provider: [[p.engine-client]]
143
+ - New Note From Selection
144
+ - provider: [[p.engine-client]]
145
+ - Rename Note
146
+ - provider: [[lsp.rename-and-prepare-rename]]
147
+ - Show Preview
148
+ - provider: [[p.dendron-mpe]]
149
+ - Lookup
150
+ - provider: [[p.engine-client]]
151
+ - Lookup Schema
152
+ - provider: [[p.engine-client]]
153
+ - Open Link
154
+ - provider: [[p.engine-client]]
155
+ - Reload Index
156
+ - provider: [[p.engine-server]]
157
+ - Archive Hierarchy
158
+ - provider: [[lsp.rename-and-prepare-rename]]
159
+ - Refactor Hierarchy
160
+ - provider: [[lsp.rename-and-prepare-rename]]
161
+ - Go Up
162
+ - provider: [[p.engine-client]]
163
+ - Go Next Sibling
164
+ - provider: [[p.engine-client]]
165
+ - Go Previous Sibling
166
+ - provider: [[p.engine-client]]
167
+ - Go Down
168
+ - provider: [[p.engine-client]]
169
+ - Initialize Workspace
170
+ - provider: [[p.dendron-extension]]
171
+ - Change Workspace
172
+ - provider: [[p.dendron-extension]]
173
+ - Show Help
174
+ - provider: [[p.dendron-extension]]
175
+ - Build Pod
176
+ - provider: [[p.engine-client]]
177
+ - Configure Pod
178
+ - provider: [[p.engine-client]]
179
+ - Import Pod
180
+ - provider: [[p.engine-client]]
181
+ - Export Pod
182
+ - provider: [[p.engine-client]]
183
+ - Doctor
184
+ - provider: [[p.engine-client]]
185
+ - Dendron:Dev: Open Logs
186
+ - provider: [[p.engine-client]]
187
+
188
+ ### Additional Functionality Via LSP
189
+ - [[lsp.publish-diagnostics]]
190
+ - [[lsp.completion-and-completion-resolve]]
191
+ - all links
192
+ - frontmatter fields
193
+ - document headers
194
+ - [[lsp.hover]]
195
+ - show preview of all links (exclude note refs)
196
+ - [[lsp.signature-help]]
197
+ - [[lsp.definition]]
198
+ - all links
199
+ - [[lsp.type-definition]]
200
+ - goto definition for all links
201
+ - go to definition for schema elements
202
+ - [[lsp.implementation]]
203
+ - inside schema, trigger this to look at all notes that implement said schema
204
+ - [[lsp.references]]
205
+ - backlinks
206
+ - [[lsp.document-highlight]]
207
+ - TBD
208
+ - [[lsp.document-symbol]]
209
+ - [[lsp.code-action]]
210
+ - fix frontmatter according to schema
211
+ - [[lsp.codelens-and-codelens-resolve]]
212
+ - [[lsp.documentlink-and-documentlink-resolve]]
213
+ - [[lsp.documentcolor-and-color-presentation]]
214
+ - [[lsp.formatting]]
215
+ - format according to markdown-lint and schema
216
+ - [[lsp.range-formatting]]
217
+ - [[lsp.ontype-formatting]]
218
+ - [[lsp.rename-and-prepare-rename]]
219
+ - [[lsp.folding-range]]
220
+ -->
221
+

Added: vault/dendron.roadmap.project.n.backlog.calendar-integration.md

vault/dendron.roadmap.project.n.backlog.calendar-integration.md ADDED
@@ -0,0 +1,106 @@
1
+ ---
2
+ id: 61833b7d-1cfe-4500-b78d-b30962a906cd
3
+ title: Google Calendar Pod
4
+ desc: ''
5
+ updated: 1608485512280
6
+ created: 1602708411014
7
+ stub: false
8
+ ---
9
+ ## Goals
10
+
11
+ Support integrating calendars like google calendar with Dendron
12
+
13
+ ## Proposal
14
+
15
+ - incorporate as a Google Calendar Pod
16
+
17
+ ### Import
18
+
19
+ ```yml
20
+ apiToken:
21
+ range: allEvents
22
+ ```
23
+
24
+ ### Sync
25
+
26
+ ```yml
27
+
28
+
29
+ ```
30
+
31
+ ## Publish
32
+
33
+ - configuration:
34
+ - summary
35
+ - location
36
+ - description
37
+ - start
38
+ - end
39
+ - not covered
40
+ - recurrence
41
+ - attendees
42
+ - reminders
43
+ - flow
44
+
45
+ ```bash
46
+ cd /path/to/workspace
47
+ dendron-cli dendron-cli publishPod --wsRoot . --vault ./vault --podId dendron.gcal --noteByName gcal.test --config /tmp/config.yml
48
+ ```
49
+
50
+ ### Resources
51
+
52
+ - api: <https://developers.google.com/calendar/create-events>
53
+ - sdk:
54
+
55
+ ```ts
56
+ // Refer to the Node.js quickstart on how to setup the environment:
57
+ // https://developers.google.com/calendar/quickstart/node
58
+ // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
59
+ // stored credentials.
60
+
61
+ var event = {
62
+ 'summary': 'Google I/O 2015',
63
+ 'location': '800 Howard St., San Francisco, CA 94103',
64
+ 'description': 'A chance to hear more about Google\'s developer products.',
65
+ 'start': {
66
+ 'dateTime': '2015-05-28T09:00:00-07:00',
67
+ 'timeZone': 'America/Los_Angeles',
68
+ },
69
+ 'end': {
70
+ 'dateTime': '2015-05-28T17:00:00-07:00',
71
+ 'timeZone': 'America/Los_Angeles',
72
+ },
73
+ 'recurrence': [
74
+ 'RRULE:FREQ=DAILY;COUNT=2'
75
+ ],
76
+ 'attendees': [
77
+ {'email': 'lpage@example.com'},
78
+ {'email': 'sbrin@example.com'},
79
+ ],
80
+ 'reminders': {
81
+ 'useDefault': false,
82
+ 'overrides': [
83
+ {'method': 'email', 'minutes': 24 * 60},
84
+ {'method': 'popup', 'minutes': 10},
85
+ ],
86
+ },
87
+ };
88
+
89
+ calendar.events.insert({
90
+ auth: auth,
91
+ calendarId: 'primary',
92
+ resource: event,
93
+ }, function(err, event) {
94
+ if (err) {
95
+ console.log('There was an error contacting the Calendar service: ' + err);
96
+ return;
97
+ }
98
+ console.log('Event created: %s', event.htmlLink);
99
+ });
100
+
101
+ ```
102
+
103
+ ### Export
104
+
105
+ ## Flows
106
+

Added: vault/dendron.roadmap.project.n.backlog.color-tabs.md

vault/dendron.roadmap.project.n.backlog.color-tabs.md ADDED
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: a4252774-0c08-4bca-a1b5-b6f369908aeb
3
+ title: Related
4
+ desc: ''
5
+ updated: 1603426502775
6
+ created: 1602430633050
7
+ ---
8
+ - [github issue](https://github.com/dendronhq/dendron/issues/261)
9
+
10
+ ## Goals
11
+
12
+ Support custom colorization of tabs in Dendron, specified by schema.
13
+
14
+ ## Details
15
+
16
+ VSCode has the following settings for tabs.
17
+
18
+ ```
19
+ "workbench.colorCustomizations": {
20
+ "tab.activeBackground": "#FFFFFF",
21
+ "tab.activeForeground":"#000000",
22
+ "tab.inactiveForeground":"#FFFFFF",
23
+ "tab.inactiveBackground":"#000000",
24
+ "tab.border":"#FFFFFF"
25
+ }
26
+ ```
27
+
28
+ The properties that can be customized are `activeBackground` and `inactiveBackground`. In addition to tab color, you can also customize the title bar (top horizontal), activity bar (side panel) and status bar(bottom bar). When they are all set, it looks something like this
29
+
30
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/project.color-tabs.jpg)
31
+
32
+ ## Proposal
33
+
34
+ ### Set custom tab color based on schema.
35
+
36
+ ```yml
37
+ schemas:
38
+ - id: project
39
+ tabColor:
40
+ value: #FFFFFF
41
+ recursive: false # default: true, optional param
42
+ ```
43
+
44
+ By default, `tabColor` would be recursive, so any child schemas would also have the property applied. More specific `tabColor` settings on child schemas would take precedence over parent `tabColor` settings.
45
+
46
+ Currently, the only way to set tab color is via the settings file which means Dendron would dynamically update your workspace settings as you navigate files.
47
+
48
+ - [per editor/tab background color](https://github.com/Microsoft/vscode/issues/35379)
49
+ - settings:
50
+ - workbench.colorTheme: per workspace/folder settings
51
+ - tab.inactiveForeground
52
+ - tab.inactiveBackground
53
+ - [discord](https://discordapp.com/channels/717965437182410783/735365126227493004/764283816130248734)
54
+ - [color tabs extension](https://marketplace.visualstudio.com/items?itemName=orepor.color-tabs-vscode-ext)
55
+

Added: vault/dendron.roadmap.project.n.backlog.md

vault/dendron.roadmap.project.n.backlog.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 529fb02a-3ca9-4fbc-bcba-9435f8d13e89
3
+ title: Backlog
4
+ desc: ''
5
+ updated: 1602132400901
6
+ created: 1602132400901
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.n.backlog.mindmap-view.md

vault/dendron.roadmap.project.n.backlog.mindmap-view.md ADDED
@@ -0,0 +1,66 @@
1
+ ---
2
+ id: 533857a4-3dcb-478e-9877-5ab7f94ed6e6
3
+ title: Mindmap View
4
+ desc: ''
5
+ updated: 1603636828393
6
+ created: 1603426485399
7
+ ---
8
+ ## Goals
9
+
10
+ Support a mindmap view for notes in Dendron.
11
+
12
+ ## Use Case
13
+
14
+ - being able to see high level view of your notes
15
+ - being able to focus on specific parts of the note hierarchy
16
+
17
+ ## Details
18
+
19
+ This project discusses the best way to implement a mind-map view into Dendron that aligns with the principles of hierarchy-first note-taking.
20
+
21
+ ## Proposal
22
+
23
+ Create a view in Dendron that will visualise a note in dendron using a mindmap format, and show it's siblings, parents and children organised legibly and semantically. This can be implemented using the React Sortable Tree plugin, which will also be used for creating schemas.
24
+
25
+ #### Organising the information connected to a node in a semantic and legible manner
26
+
27
+ A standard graph view spreads the connected nodes arbitratily around the outside of a parent node. This is useful for understanding the general 'shape' of the connections between notes, but in order to understand the immediate connections between any particular note it is easier if they are arranged in a structured and comprehensible fashion. A view that visualises notes in a mindmap style format can achieve this.
28
+
29
+ #### Activating mindmap view
30
+
31
+ The mindmap view can be triggered through the command palette as a Dendron command, as well as from an icon in the Activity Bar, or through the right-click context menu on a note. Launching it from the activity bar or command palette will launch it in the root of your vault, while launching it from the right click context menu on a note will open it focused to that particular note.
32
+
33
+ #### Indication of related note
34
+
35
+ When a note is opened from the mindmap view (or the mindmap view is opened from a note), it is linked so that navigating to other notes via the mindmap panel will open them in that same panel. This can be indicated by an icon in the menu bar of the linked panel, or an icon in the tab in the linked panel.
36
+
37
+ #### Creation of new child notes by clicking
38
+
39
+ A '+' icon on a note when clicked can add a child note underneath that note.
40
+
41
+ #### Schema visualisation
42
+
43
+ A mindmap-style visualisation lends itself to visualising the abstract concept of a schema. A note with a schema applied shows the potential nodes that it could have according to the schema as transparent notes with a '+' symbol, which when clicked will create that note.
44
+
45
+ #### Expanding scope of mindmap focus
46
+
47
+ The mindmap view can also be expanded to show additional generations of notes from the same focused note (the grandparents and grandchildren of the focused note). There are '+' and '-' buttons in the mindmap view panel to increase or decrease the amount of visible generations.
48
+
49
+ #### Configuration options
50
+
51
+ TBD
52
+
53
+ ## Questions
54
+
55
+ ### What is the difference between this and Dendron's graph view?
56
+
57
+ The graph view shows an overview of your _entire knowledge base_ and can be traversed by scrolling and zooming. This can be useful for understand the general structure of all your notes, and the broad relationships between domains in your hierarchy but is less suited for focusing on a particular domain.
58
+
59
+ The mindmap view would allow users to focus their attention on a particular node, it's siblings, parents and children, view them in a visually organised manner, and traverse their notes by selecting notes directly attached to that domain. In this sense, it is more suited to giving you an overview of a particular _domain_.
60
+
61
+ ## Resources
62
+
63
+ - [The Brain App](https://www.thebrain.com/)
64
+ - [Discussion](https://discordapp.com/channels/717965437182410783/739186036495876126/766252142549270550)
65
+ - [React Sortable Tree](https://github.com/mikcaweb/react-sortable-tree)
66
+

Added: vault/dendron.roadmap.project.n.backlog.org-mode.md

vault/dendron.roadmap.project.n.backlog.org-mode.md ADDED
@@ -0,0 +1,59 @@
1
+ ---
2
+ id: c3800271-dd56-46fb-8de7-e850f3c006b7
3
+ title: Org Mode
4
+ desc: ''
5
+ updated: 1608485548393
6
+ created: 1602131829574
7
+ stub: false
8
+ ---
9
+ ## Goals
10
+
11
+ Support org-mode sytnax within Dendron
12
+
13
+ ## Details
14
+
15
+ This project discusses how to best incorporate org-mode functionality into dendron
16
+
17
+ ## Proposals
18
+
19
+ 1. support {file}.org files
20
+ 2. support `org` syntax within `md` files
21
+
22
+ ### 1. Support {file}.org files
23
+
24
+ - have dendron support .org files
25
+
26
+ - pros:
27
+ - works with existing vscode extensions (eg. [vscode org-mode](https://marketplace.visualstudio.com/items?itemName=tootone.org-mode)
28
+ - can be edited in emacs
29
+
30
+ - cons:
31
+ - uncertain how to implement dendron specific syntax and features (eg. note references, schemas, etc)
32
+
33
+ ## 2. support `org` syntax within `md` files
34
+
35
+ - implement org-mode as a fenced block
36
+
37
+ - pros:
38
+ - compatible with existing markdown tool chain
39
+
40
+ - cons:
41
+ - might not be compatible with emacs and existing org-mode toolchain
42
+
43
+ ## Thoughts
44
+
45
+ Currently i'm leaning towards 1). folks that want org-mode support in dendron can create markdown files and manually set the filetype to org mode. it's not ideal since you lose the preview but other functions like lookup still work.
46
+
47
+ Changing filetype has a custom command. VSCode has a default shortcut (`cmd+k m` on mac) that can be re-mapped.
48
+
49
+ ```
50
+ "command": "workbench.action.editor.changeLanguageMode",
51
+ ```
52
+
53
+ ## Next
54
+
55
+ - [ ] look at prior work in this area (embedding org-mode in other applications)
56
+ - [ ] collect feedback
57
+ - [ ] figure out if `changeLanguageMode` accepts args (would be great if you could toggle to org-mode and back using a single shortcut)
58
+ - [ ] schedule org-mode implementation
59
+

Added: vault/dendron.roadmap.project.n.md

Files changed (1) hide show
  1. vault/dendron.roadmap.project.n.md +9 -0
vault/dendron.roadmap.project.n.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 167bd57c-fb54-4a71-85b2-c26ba6df29fc
3
+ title: 'Entries'
4
+ desc: ''
5
+ updated: 1601139430372
6
+ created: 1601139430372
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.scratch.2020.09.07-121834.md

vault/dendron.roadmap.project.scratch.2020.09.07-121834.md ADDED
@@ -0,0 +1,54 @@
1
+ ---
2
+ id: 012b49e8-7638-4856-afc2-2db3c6406a86
3
+ title: Log
4
+ desc: ''
5
+ updated: 1599506314235
6
+ created: 1599506314235
7
+ stub: false
8
+ source: >
9
+ -
10
+ https://discordapp.com/channels/717965437182410783/735365126227493004/752606691518054450
11
+ ---
12
+ ## Jojo
13
+
14
+ @kevins8 vaults have somewhat sparse documentation, especially possible multi-vault setups. Let's say I'd like to separate work and home into distinct vaults, maybe even so that other vault is a symbolic link to dropbox or whatever. Would that work? Also, what happens if there's a filename collision across vaults?
15
+
16
+ ## Jojo
17
+
18
+ multi-vault support is on the roadmap for this year. for naming collisions, i was thinking the following:
19
+
20
+ - by default, surface all results with the vault name in the prefix
21
+
22
+ say a user has the following vaults
23
+
24
+ ```
25
+ .
26
+ └── workspace
27
+ ├── kevin-vault
28
+ │ └── python.hello.md
29
+ └── jojo-vault
30
+ └── python.hello.md
31
+ ```
32
+
33
+ user enters the following lookup: `python.hello`
34
+
35
+ they should see the following result
36
+
37
+ ```
38
+ python.hello - kevin vault
39
+ python.hello - jojo vault
40
+ ```
41
+
42
+ we can also introduce a vault specific prefix (eg. {vault}/{path}) to un-ambiguously specify our result
43
+
44
+ user would type `kevin-vault/python.hello` to specify they want to access `kevin-vault`
45
+
46
+ "why don't we just show all matches for an unprefixed link" - this would work inside vscode, but if the user just publishes the workspace with conflicting vaults, I guess the link must point to some single pre-selected place(?). Also, I think the intent behind the link is to point to a single location, so asking user to fix it would probably be reasonable.
47
+ There's probably all kind of complex scenarios that we could envision (e.g. what if the user would like to merge domains across vaults and show all merged notes in the published page as a merged web page?), but then again 99.9% of the real cases probably just want to use multiple folders and avoid conflicts. Showing errors would probably be the easiest and still sufficient solution.
48
+
49
+ ### Kevin
50
+
51
+ coming back to this thread. agree with your conclusion. the other solution would be to generate a popup/intermediary page for links with multiple destinations and let the user choose.
52
+ e
53
+ for v1, would bias for what you suggested and error at build time.
54
+

Added: vault/dendron.roadmap.project.scratch.2020.09.07-121952.md

vault/dendron.roadmap.project.scratch.2020.09.07-121952.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ id: 02b1c04d-fc7e-4af9-9ffc-a661ac3da394
3
+ title: Log
4
+ desc: ''
5
+ updated: 1599506392418
6
+ created: 1599506392418
7
+ stub: false
8
+ source: >
9
+ -
10
+ https://discordapp.com/channels/717965437182410783/735365126227493004/752607009068810340
11
+ ---
12
+ ## bsqrd
13
+
14
+ I hve a question around the same context, say you consider all of your vault to be private and not really shareable, but you would still like to share bits and pieces from a couple notes and make them public. Would creating, say a public._ or garden._ hierarchy and then in each note you would reference the interesting bits and pieces from the rest of the private notes be feasible ?
15
+
16
+ I guess to simplify my question: can you publish notes that have references to private / non-published notes ?
17
+
18
+ ## kevin
19
+
20
+ the mental model I had in my head for vaults (and its not set in stone) is that a hierarchy could exist spread across multiple vaults. each vault is a github repo. you can there fore have a public vault and a private vault and you can choose to share everything in one but nothing in the other
21
+ what's nice about this model is that you still get to have one unified hierarchy that can span any number of vaults
22
+

Added: vault/dendron.roadmap.project.scratch.2020.09.07-164009.md

vault/dendron.roadmap.project.scratch.2020.09.07-164009.md ADDED
@@ -0,0 +1,103 @@
1
+ ---
2
+ id: 700b02fc-1e6c-46b1-8d68-5d8e17a55d33
3
+ title: Evernote Pod Proposal
4
+ desc: ''
5
+ updated: 1599522009420
6
+ created: 1599522009420
7
+ stub: false
8
+ ---
9
+ - link to tool: <https://evernote.com>
10
+
11
+ - one line description: online note taking tool that organizes notes using notebooks and tags
12
+
13
+ - is there a public api available (if so, please provide link)? yes
14
+ - <https://dev.evernote.com/doc/>
15
+
16
+ - are there existing (preferably javascript compatible) libraries that can import and/or export to this pod? (if so, please list them. if there aren't libraries, an example of importing is also good): yes
17
+ - import:
18
+ - import del.icio.us bookmarks into evernote: <https://github.com/jorgemanrubia/evernicious> #ruby #example
19
+ - export:
20
+ - export evernote notes: <https://github.com/akosbalasko/yarle> #typescript
21
+
22
+ - are there existing (preferably javascript compatible) libraries that can convert from/to the data format used in this pod? (if so, please list them): yes
23
+ - convert from
24
+ - <https://github.com/akosbalasko/yarle> #typescript
25
+ - convert to
26
+
27
+ ## Import
28
+
29
+ &lt;What does import look like? How will the organization of the source pod be mapped onto Dendron's Hierarchy?>
30
+
31
+ ### mappings
32
+
33
+ - notebook stack & notebooks: hierarchy
34
+ - tags -> tags
35
+
36
+ ### example
37
+
38
+ - evernote
39
+
40
+ ```
41
+ - Cookbook (notebook stack)
42
+ - Meat (notebook)
43
+ - meat note 1
44
+ - meat note 2
45
+ - ...
46
+ - Vegetables (notebook)
47
+ - ...
48
+ ```
49
+
50
+ - dendron
51
+
52
+ ```
53
+ - cookbook
54
+ - cookbook.meat
55
+ - cookbook.meat.meat-note-1
56
+ - cookbook.meat.meat-note-2
57
+ - cookbook.vegetables
58
+ ```
59
+
60
+ ## Build
61
+
62
+ &lt;What does build look like? What steps need to occur prior to exporting your Dendron notes>
63
+
64
+ ## Export
65
+
66
+ &lt;What does export look like? How will we map Dendron's hierarchies to the destination pod's organization?>
67
+
68
+ ### mappings
69
+
70
+ - hierarchy -> notebook stack or notebook (user can configure on a per hierarchy basis)
71
+
72
+ -
73
+
74
+ - dendron
75
+
76
+ ```
77
+ - cookbook.meat
78
+ - cookbook.meat.meat-note-1
79
+ - cookbook.meat.meat-note-2
80
+ - cookbook.vegetables
81
+ ```
82
+
83
+ <!-- ## Configuration
84
+ <What might a configuration file look like to help make sure your data is formatted correctly ?>
85
+
86
+ e.g.
87
+ destinations:
88
+ - destination:
89
+ base: People
90
+ table: Interactions
91
+ src:
92
+ meet.{today}.*
93
+ mapping:
94
+ fm.created: DateV2
95
+ fm.type: Type
96
+ section.noes: Notes
97
+ section.people: People
98
+ -->
99
+
100
+ ## Example Use Cases
101
+
102
+ &lt;e.g. Sync notes from meetings with an airtable tracking meetings across days and people>
103
+

Added: vault/dendron.roadmap.project.scratch.2020.09.md

vault/dendron.roadmap.project.scratch.2020.09.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: f81bd621-b918-4003-b6d8-6efd99a42a5b
3
+ title: 09
4
+ desc: ''
5
+ updated: 1601139430377
6
+ created: 1601139430377
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.scratch.2020.md

vault/dendron.roadmap.project.scratch.2020.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: dba0543d-dd60-4d8a-904e-d347f9f862ee
3
+ title: '2020'
4
+ desc: ''
5
+ updated: 1601139430377
6
+ created: 1601139430377
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.scratch.md

vault/dendron.roadmap.project.scratch.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: c17fa26b-702b-47b7-a9a2-4a8218fc26e4
3
+ title: Scratch
4
+ desc: ''
5
+ updated: 1601139430377
6
+ created: 1601139430377
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.roadmap.project.template.md

vault/dendron.roadmap.project.template.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ id: 28acd3e7-2102-4b8d-8d69-0d7b2f83bb54
3
+ title: Template
4
+ desc: ''
5
+ updated: 1600842066371
6
+ created: 1600842066371
7
+ stub: false
8
+ start: null
9
+ end: null
10
+ status: null
11
+ ---
12
+ ## Goal
13
+
14
+ ## Details and Discussion
15
+
16
+ ## Release Notes
17
+
18
+ ## Tasks
19
+
20
+ - [ ]
21
+ - [ ]
22
+

Added: vault/dendron.scratch.2020.09.12-091632.md

vault/dendron.scratch.2020.09.12-091632.md ADDED
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: 65745697-0f30-43d8-9085-a213e8227e8b
3
+ title: data
4
+ desc: ''
5
+ updated: 1599927392112
6
+ created: 1599927392112
7
+ stub: false
8
+ ---
9
+
10
+
11
+ ### opts.replaceRefs
12
+ ```ts
13
+ engine:DendronEngine {notes: {…}, initialized: true, props: {…}, store: FileStorage, fuse: Fuse, …}
14
+ imageRefPrefix:undefined
15
+ refReplacements:{
16
+ wikiLink2Html:false
17
+ wikiLink2Md:true
18
+ wikiLinkPrefix:''
19
+ wikiLinkUseId:true
20
+ }
21
+ ```

Added: vault/dendron.scratch.2020.09.md

Files changed (1) hide show
  1. vault/dendron.scratch.2020.09.md +9 -0
vault/dendron.scratch.2020.09.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: 8b563033-ce98-4142-868d-277dc34c2d4c
3
+ title: 09
4
+ desc: ''
5
+ updated: 1600448077610
6
+ created: 1600448077610
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.scratch.2020.11.13-123350.md

vault/dendron.scratch.2020.11.13-123350.md ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: 56f29f63-9803-4870-979d-c795c36e2bcb
3
+ title: Tags
4
+ desc: ''
5
+ updated: 1605585526413
6
+ created: 1605299633017
7
+ ---
8
+ - multi vault (current)
9
+ - make it possible to have multiple issues
10
+
11
+ - publishing 2.0
12
+ - multiplayer mode
13
+
14
+ - preview 2.0
15
+
16
+ - visualizations 2.0
17
+
18
+ - tree view 2.0
19
+
20
+ ## status
21
+
22
+ - good first issue
23
+
24
+ ## size
25
+

Added: vault/dendron.scratch.2020.11.md

Files changed (1) hide show
  1. vault/dendron.scratch.2020.11.md +13 -0
vault/dendron.scratch.2020.11.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ id: 9f30ca08-965e-4896-ae74-d151d101bd18
3
+ title: '11'
4
+ desc: ''
5
+ updated: 1605320735084
6
+ created: 1605320735084
7
+ stub: false
8
+ parent: eead7fd1-f43e-44a1-bee3-2550d83e5476
9
+ children:
10
+ - 56f29f63-9803-4870-979d-c795c36e2bcb
11
+ ---
12
+
13
+

Added: vault/dendron.scratch.2020.md

Files changed (1) hide show
  1. vault/dendron.scratch.2020.md +9 -0
vault/dendron.scratch.2020.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: eead7fd1-f43e-44a1-bee3-2550d83e5476
3
+ title: '2020'
4
+ desc: ''
5
+ updated: 1600448077609
6
+ created: 1600448077609
7
+ stub: false
8
+ ---
9
+

Added: vault/dendron.scratch.md

Files changed (1) hide show
  1. vault/dendron.scratch.md +10 -0
vault/dendron.scratch.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 9688f51b-49fb-4012-8845-0012f0dcf56f
3
+ title: Scratch
4
+ desc: ''
5
+ updated: 1600448077609
6
+ created: 1600448077609
7
+ stub: false
8
+ nav_exclude: true
9
+ ---
10
+

Added: vault/dendron.template.design.md

Files changed (1) hide show
  1. vault/dendron.template.design.md +10 -0
vault/dendron.template.design.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 861cbdf8-102e-4633-9933-1f3d74df53d2
3
+ title: Reference
4
+ desc: ''
5
+ updated: 1602033087611
6
+ created: 1602033087611
7
+ stub: false
8
+ ---
9
+
10
+

Added: vault/dendron.template.example.md

Files changed (1) hide show
  1. vault/dendron.template.example.md +10 -0
vault/dendron.template.example.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: a7c3a810-28c8-4b47-96a6-8156b1525af3
3
+ title: Example Template
4
+ desc: ''
5
+ updated: 1595952505038
6
+ created: 1595952505038
7
+ stub: false
8
+ ---
9
+
10
+ I am text from a template.

Added: vault/dendron.template.md

Files changed (1) hide show
  1. vault/dendron.template.md +10 -0
vault/dendron.template.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 8e2272bd-ad24-4806-b588-da2bcfa6ea11
3
+ title: Template
4
+ desc: ''
5
+ updated: 1596318372330
6
+ created: 1596318372330
7
+ stub: false
8
+ nav_exclude: true
9
+ ---
10
+

Added: vault/dendron.testimonials.ben.md

Files changed (1) hide show
  1. vault/dendron.testimonials.ben.md +11 -0
vault/dendron.testimonials.ben.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: e6e596c7-6407-457b-b90d-9f2006aa9e51
3
+ title: Ben
4
+ desc: ''
5
+ updated: 1614907233285
6
+ created: 1614907201815
7
+ ---
8
+
9
+ > Once you start using Dendron you never look back. Saving all the files in one folder is incredibly liberating, fast and efficient. Try it for a few days and you will see. Getting your thoughts and information down into a hierarchy is so quick and easy. I am loving the experience. (I have only been using Dendron for a few days now. And it is a game changer for me. CTL + L is your friend.)
10
+
11
+ - Ben Vautier, Co-Founder

Added: vault/dendron.testimonials.ed.md

Files changed (1) hide show
  1. vault/dendron.testimonials.ed.md +12 -0
vault/dendron.testimonials.ed.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: e836000e-2ef9-4d9e-af11-1bdfde171a52
3
+ title: Ed
4
+ desc: ''
5
+ updated: 1607965554626
6
+ created: 1599936228898
7
+ stub: false
8
+ ---
9
+
10
+ > There is a learning curve to getting to know Dendron, but I find it a little like Excel - once you are in and tame the beast, it is hard to get out.
11
+
12
+ - Ed, Accountant

Added: vault/dendron.testimonials.luke.md

Files changed (1) hide show
  1. vault/dendron.testimonials.luke.md +12 -0
vault/dendron.testimonials.luke.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: 33d46152-89dd-4d7b-a4b6-1223d4fa8df8
3
+ title: Luke
4
+ desc: ''
5
+ updated: 1607965511584
6
+ created: 1603729976071
7
+ ---
8
+
9
+ > Hierarchies [are] such a game changer, and is simultaneously what put me off trying Dendron (I really wanted to try the "flat hierarchy with just links" concept) and later drew me in again. I just couldn't organise myself with a flat structure and ended up spreading notes out.
10
+ > I think the key thing that changed my perspective was the ease of restructuring hierarchies, it gives you the confidence to just write, safe in the knowledge that you can just restructure it later
11
+
12
+ - Luke Carrier, Site Reliability Engineer

Added: vault/dendron.testimonials.md

Files changed (1) hide show
  1. vault/dendron.testimonials.md +13 -0
vault/dendron.testimonials.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ id: b08155fe-c5c6-4d4c-a737-d500923f35ad
3
+ title: Testimonials
4
+ desc: ''
5
+ updated: 1614907260928
6
+ created: 1599596104324
7
+ stub: false
8
+ nav_order: 2.1
9
+ ---
10
+ This page is a collection of nice things that people have said about Dendron. If you want to add to it, feel free to add it using the `Edit` link on the bottom of the page or messaging kevin at [kevin@dendron.so](mailto:kevin@dendron.so) 🙏
11
+
12
+ ![[dendron.testimonials.*]]
13
+

Added: vault/dendron.testimonials.myles.md

Files changed (1) hide show
  1. vault/dendron.testimonials.myles.md +16 -0
vault/dendron.testimonials.myles.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 2367a2af-c216-414b-88bf-02acd9d4eca4
3
+ title: Myles
4
+ desc: ''
5
+ updated: 1607965546166
6
+ created: 1599936132300
7
+ stub: false
8
+ ---
9
+
10
+ > I started taking organised notes in 1993. I had read 'Lila' by Robert Pirsing and 'The Tao of Physics' by Fritjof Capra, both of whom used index card systems to organise those books. I've never stopped taking notes since 1993. I may have a few thousand more notes than @kevins8.
11
+ > I've used apps - everything from Filemaker Pro, to Mark Bernstein's excellent Tinderbox, to DevonThink, to Tiddlywiki, to ones i've written myself, and dozens more, including the latest batch of 'tools for thought'.
12
+ > Given my volume of notes over decades, I know a bit about the cul-de-sacs knowledge systems run into. I use new knowledge apps to see how they feel, but mostly studiously avoid getting stuck into complex systems and closed silos. I'm allergic to apps that are too limited for my volume and density of knowledge. I can't use Roam. I can almost use logseq. I can use dendron.
13
+ > Kevin hid a copy of Vannevar Bush's 'As We May Think' in the dendron codebase. It's definitely true that the original vision of the hyperweb is back: something is changing today - a new level of literacy or a higher level of knowledge is emerging, and language, logic, and code are merging. This isn't the late 90's, no company is going to 'win'. Instead, a few pioneers are going to build a bridge to a new level of thought for networked humanity.
14
+ > Dendron stands apart from the pack. Kevin is on to something. Excited to see where he leads.
15
+
16
+ - Myles Byrne, Semantic Web Developer

Added: vault/dendron.testimonials.ryan.md

Files changed (1) hide show
  1. vault/dendron.testimonials.ryan.md +21 -0
vault/dendron.testimonials.ryan.md ADDED
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: 0ddffabc-c78b-4765-a3df-8ffa35dd1391
3
+ title: Ryan
4
+ desc: ''
5
+ updated: 1611363336731
6
+ created: 1611363202953
7
+ ---
8
+
9
+
10
+
11
+ > Here's my perspective as a full-time college librarian who's also a humanities grad student & journal editor:
12
+
13
+ > I was interested in Obsidian briefly before choosing Dendron. The biggest factors for choosing Dendron are the hierarchical structure, the multiple vaults, and the many existing VS Code extensions.
14
+
15
+ > Hierarchies make a lot more sense to my brain. And some of the research I've glanced at suggests it is better for PKM than tags or other free-form structures.
16
+
17
+ > Having multiple vaults made me comfortable jumping fully into Dendron. I currently have 3 separate vaults: one for my daily life & work as a librarian/journal editor, a second for my dissertation-related things, and a third that my wife & I will soon start syncing on our separate computers. I'll eventually make a fourth for notes I'll publish on my website—but this is the start of the semester, and I have to avoid that kind of exciting but time-intensive project at the moment! I appreciate that references will work between these vaults—but I don't need to worry about accidentally sharing a note with a link to "project.kitchen-plumbing-disaster" with my dissertation advisor, or flood my wife's computer with my reading notes and dissertation idea fragments. This fundamental separation lets me feel comfortable using one tool for all these disparate domains.
18
+
19
+ > Having the full range of existing VS Code extensions for things like Pandoc, BibTeX, or Zotero, plus web development, means that I don't need to hope that someone else involved with Obsidian, Foam, etc will make a plug-in that does what I need for an edge case use. Dendron plugs into a much larger pool of people, many of whose are doing academic and web-related work. I don't do much with data analysis, but I imagine it would be nice to use VS Code tools for Python or R in the same program one uses for academic writing.
20
+
21
+ - Ryan, Librarian

Added: vault/dendron.testimonials.tom.md

Files changed (1) hide show
  1. vault/dendron.testimonials.tom.md +12 -0
vault/dendron.testimonials.tom.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: cd55a110-0597-4d55-99d7-2bd63787959e
3
+ title: Tom
4
+ desc: ''
5
+ updated: 1607965547196
6
+ created: 1599936256433
7
+ stub: false
8
+ ---
9
+
10
+ > Dendron is awesome. Each day the simple things are getting easier
11
+
12
+ - Tom Diaz MD, Researcher/Technologist

Added: vault/dendron.testimonials.tyler.md

Files changed (1) hide show
  1. vault/dendron.testimonials.tyler.md +10 -0
vault/dendron.testimonials.tyler.md ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+ id: 1a7d8768-2056-448e-b587-9f56c104f5b3
3
+ title: Tyler
4
+ desc: ''
5
+ updated: 1607965552845
6
+ created: 1601136275766
7
+ ---
8
+ > The last time I felt excited about learning a tool like this was when I started learning vim... it has never stopped and I suspect my usage of this tool will evolve similarly.
9
+
10
+ - Tyler Nieman, Software engineeer/Illustrator

Added: vault/dendron.topic.capabilities.md

vault/dendron.topic.capabilities.md ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ id: 11787828-866c-48f0-9b2b-4ad4e0519698
3
+ title: Capabilities
4
+ desc: ''
5
+ updated: 1604209668061
6
+ created: 1595952505033
7
+ ---

Added: vault/dendron.topic.capabilities.snapshot.md

vault/dendron.topic.capabilities.snapshot.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: 4473581a-cfdf-4d98-89a9-2955b308b669
3
+ title: Snapshots
4
+ desc: ''
5
+ updated: 1604240847774
6
+ created: 1604209673048
7
+ ---
8
+ You can make a snapshot of your entire vault using the `Snapshot Vault` Command.
9
+
10
+ This will save all your vaults into `snapshots/{current_timestamp}`
11
+
12
+ ## Commands
13
+
14
+ ((ref:[[dendron.topic.commands]]#snapshot vault:#*))
15
+
16
+ You can restore your snapshots using the `Restore Vault` Command
17
+
18
+ ((ref:[[dendron.topic.commands]]#restore vault:#*))
19
+

Added: vault/dendron.topic.cli.md

Files changed (1) hide show
  1. vault/dendron.topic.cli.md +187 -0
vault/dendron.topic.cli.md ADDED
@@ -0,0 +1,187 @@
1
+ ---
2
+ id: 23a1b942-99af-45c8-8116-4f4bb7dccd21
3
+ title: Dendron CLI
4
+ desc: ''
5
+ updated: 1614924024964
6
+ created: 1600033791071
7
+ ---
8
+ The Dendron CLI exposes Dendron's functionality via the command line.
9
+
10
+ ## Installation
11
+
12
+ ```
13
+ npm install -g @dendronhq/dendron-cli
14
+ ```
15
+
16
+ ## Engine Commands
17
+
18
+ ### doctor 🚧
19
+
20
+ Use doctor to perform specific fixes over your notes.
21
+
22
+ - NOTE: the functionality here is different from what is available in the plugin version of [[Doctor|dendron.topic.commands#doctor]].
23
+
24
+ ```bash
25
+ doctor helps you fix your notes
26
+
27
+ Options:
28
+ --version Show version number [boolean]
29
+ --help Show help [boolean]
30
+ --wsRoot location of workspace [required]
31
+ --enginePort If set, connecto to running engine. If not set, create new
32
+ instance of Dendron Engine
33
+ --action what action the doctor should take
34
+ [array] [choices: "h1ToTitle", "h1ToH2"]
35
+ --query run doctor over a query [string]
36
+ --limit limit num changes [number]
37
+ --dryRun dry run [boolean]
38
+ ```
39
+
40
+ #### available actions
41
+
42
+ - h1ToTitle: remove initial `h1` header and use it to replace contents of `title` field in frontmatter
43
+ - h1ToH2: convert all initial `h1` header to `h2` header
44
+
45
+ #### examples
46
+
47
+ - convert all `h1` tags to frontmatter `title` values for the `readings` hiearchy
48
+
49
+ ```bash
50
+ dendron-cli doctor --wsRoot . --action h1ToTitle --limit 10 --query "readings.*"
51
+ ```
52
+
53
+ - see log
54
+
55
+ ```bash
56
+ LOG_LEVEL=info LOG_DST=stdout dendron-cli doctor --wsRoot . --action h1ToTitle --limit 10
57
+ ```
58
+
59
+ ### launchEngineServer
60
+
61
+ Launch the [[dendron server|dendron.roadmap.project.n.2020.server-migration]]. Useful for development purposes or to launch the server in a specified port
62
+
63
+ The CLI will also write out `.dendron.*` [[metadata files|dendron.ref.layout#file-tree]] in the workspace root just the same as the Dendron plugin.
64
+
65
+ ```
66
+ dendron-cli launchEngineServer --wsRoot ~/Dendron/ --vaults ~/Dendron/vault --port 3005
67
+ ```
68
+
69
+ ## Publishing Commands
70
+
71
+ ### buildSite (DEPRECATED)
72
+
73
+ Build dendron site.
74
+
75
+ ```
76
+ dendron-cli buildSite
77
+
78
+ build notes for publication
79
+
80
+ Options:
81
+ --version Show version number [boolean]
82
+ --help Show help [boolean]
83
+ --wsRoot location of workspace [required]
84
+ --vault location of vault [required]
85
+ --writeStubs writeStubs [default: true]
86
+ --incremental use rsync to only copy files that changed
87
+ [boolean] [default: false]
88
+ --dryRun don't actually build [boolean] [default: false]
89
+ ```
90
+
91
+ - eg
92
+
93
+ ```
94
+ dendron-cli buildSite --wsRoot . --vault ./vault
95
+ ```
96
+
97
+ ### publishNotes (DEPRECATED)
98
+
99
+ Publish a dendron site
100
+
101
+ ```
102
+ dendron-cli publishNotes
103
+
104
+ Build, commit, and push your notes for publication
105
+
106
+ Options:
107
+ --version Show version number [boolean]
108
+ --help Show help [boolean]
109
+ --wsRoot location of workspace [required]
110
+ --vault location of vault [required]
111
+ --writeStubs writeStubs [default: true]
112
+ --incremental use rsync to only copy files that changed
113
+ [boolean] [default: false]
114
+ --dryRun don't actually build [boolean] [default: false]
115
+ --noPush don't push the result [boolean]
116
+ --publishRepoDir repo to publish from. default is same as `wsRoot`
117
+ ```
118
+
119
+ - eg:
120
+
121
+ ```
122
+ dendron-cli publishNotes --wsRoot . --vault ./vault
123
+ ```
124
+
125
+ ### buildSiteV2
126
+
127
+ ```bash
128
+ dendron-cli buildSiteV2
129
+
130
+ build notes for publication using 11ty
131
+
132
+ Options:
133
+ --version Show version number [boolean]
134
+ --help Show help [boolean]
135
+ --wsRoot location of workspace [required]
136
+ --enginePort If set, connecto to running engine. If not set, create new
137
+ instance of Dendron Engine
138
+ --serve serve over local http server [boolean] [default: false]
139
+ --stage serve over local http server
140
+ [choices: "dev", "prod"] [default: "dev"]
141
+ --servePort port to serve over [default: "8080"]
142
+ --output if set, override output from config.yml [string]
143
+ --custom11tyPath if set, path to custom 11ty installation [string]
144
+ ```
145
+
146
+ #### Connect to Open Workspace
147
+
148
+ Normally, this command will spawn a new Dendron Engine that indexes your notes before building them for publication. You can skip this initial indexing if you have a current Dendron workspace running.
149
+
150
+ In that case, the CLI can connect to the current engine instead of starting a new one using the following command.
151
+
152
+ ```bash
153
+ cd {root/of/workspace}
154
+ # .dendron.port has the port of the current running workspace
155
+ npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve --enginePort `cat .dendron.port`
156
+ ```
157
+
158
+ ## Pod Commands
159
+
160
+ - NOTE: you can find pod ids in the [[pods|dendron.topic.pod]] page. Just add a `.import|.export` to the end of the id (eg. `dendron.pod.json.import`)
161
+
162
+ ### Export Pod
163
+
164
+ - export a pod
165
+
166
+ - eg: Export notes to JSONPod
167
+
168
+ ```
169
+ dendron-cli exportPod --podId dendron.json --wsRoot .
170
+ ```
171
+
172
+ ### Import Pod
173
+
174
+ - eg: Import notes from FilePod
175
+
176
+ ```
177
+ dendron-cli importPod --podId dendron.markdown --vault "/Users/kevinlin/Dendron-es/vault" --podsDir /Users/kevinlin/Dendron-es/pods
178
+ ```
179
+
180
+ ### Publish Pod
181
+
182
+ - eg: Publish a note as regular markdown
183
+
184
+ ```bash
185
+ dendron-cli publishPod --wsRoot . --vault ./vault --podId dendron.markdown --noteByName dendron
186
+ ```
187
+

Added: vault/dendron.topic.commands.md

Files changed (1) hide show
  1. vault/dendron.topic.commands.md +432 -0
vault/dendron.topic.commands.md ADDED
@@ -0,0 +1,432 @@
1
+ ---
2
+ id: eea2b078-1acc-4071-a14e-18299fc28f47
3
+ title: Commands
4
+ desc: ''
5
+ updated: 1615240879684
6
+ created: 1595261816971
7
+ ---
8
+ ---
9
+ ## Lookup
10
+ ### Contribute
11
+ - shortcuts: none
12
+
13
+
14
+ Become an environmentalist and keep Dendron sustainable
15
+
16
+ This command takes you to Dendron's [Environmentalist](https://accounts.dendron.so/account/subscribe) plans.
17
+ Environmentalists are users that can support Dendron financially through a monthly contribution. Environmentalist get access to insider builds, priority support, and access to exclusive dev channels.
18
+
19
+
20
+
21
+ ---
22
+
23
+ ## Notes
24
+
25
+ ### Create Daily Journal Note
26
+
27
+ - shortcuts:
28
+ - key: `ctrl+shift+i`
29
+ - mac: `cmd+shift+i`
30
+ - when: `editorFocus`
31
+
32
+ Create a global journal note
33
+
34
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
35
+
36
+ ### Copy Note Link
37
+
38
+ - shortcuts:
39
+ - key: `ctrl+shift+c`
40
+ - mac: `cmd+shift+c`
41
+ - when: `editorFocus`
42
+
43
+ Copy wiki link to note. The title of the note will be applied as the note alias. If you highlighter a header, dendron will create a relative link to the header with the alias set to the header value.
44
+
45
+ If you use this command in a [[multi vault|dendron.topic.multi-vault]] workspace, Dendron will create a [[cross vault link|dendron.topic.links#cross-vault-links]] to the note in question.
46
+
47
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
48
+
49
+ ### Copy Note Ref
50
+
51
+ - shortcuts:
52
+ - key: `ctrl+shift+r`
53
+ - mac: `cmd+shift+r`
54
+ - when: `editorFocus`
55
+
56
+ Copies a reference to the current open document
57
+
58
+ Lets you quickly create a [[note reference|dendron.topic.refs]] to the current note.
59
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
60
+
61
+ If you have a header selected while running this command, it will copy the note ref with the selected header to the next note ref
62
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.copy-selection.gif)
63
+
64
+ If you use this command in a [[multi vault|dendron.topic.multi-vault]] workspace, Dendron will create a [[cross vault link|dendron.topic.links#cross-vault-links]] to the note in question.
65
+
66
+ ### Delete Node
67
+
68
+ - shortcuts:
69
+ - key: `ctrl+shift+d`
70
+ - mac: `cmd+shift+d`
71
+
72
+ Delete a note or schema
73
+
74
+ ### Move Note
75
+
76
+ Move a note. Also includes option to move a note between vaults
77
+
78
+ ### Paste Link
79
+
80
+ Transform URL in clipboard to nicely formatted markdown link
81
+
82
+ ### Rename Note
83
+
84
+ - shortcuts: none
85
+
86
+ Rename a note and all backlinks
87
+
88
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
89
+
90
+ ### Show Preview
91
+
92
+ - shortcuts:
93
+ - windows: `windows+ctrl+p`
94
+ - mac: `cmd+ctrl+p`
95
+
96
+ Show Markdown Preview
97
+
98
+ * * *
99
+
100
+ ## Navigation
101
+
102
+ ### Lookup
103
+
104
+ - shortcuts:
105
+ - mac: `cmd+L`
106
+ - key: `ctrl+l`
107
+
108
+ Initiate note lookup
109
+
110
+ ![[dendron.topic.lookup]]
111
+
112
+ ### Lookup (Journal Note)
113
+
114
+ - shortcuts:
115
+ - key: `ctrl+shift+j`
116
+ - mac: `cmd+shift+j`
117
+ - args: `{'noteType': 'journal'}`
118
+
119
+ Initiate note lookup with journal note pre-selected
120
+
121
+ ### Lookup (Scratch Note)
122
+
123
+ - shortcuts:
124
+ - key: `ctrl+shift+s`
125
+ - mac: `cmd+shift+s`
126
+ - args: `{'noteType': 'scratch', 'selectionType': 'selection2link'}`
127
+
128
+ Initiate note lookup with scratch note pre-selected
129
+
130
+ ### Lookup Schema
131
+
132
+ - shortcuts:
133
+ - mac: `cmd+shift+L`
134
+ - key: `ctrl+shift+l`
135
+
136
+ Initiate schema lookup
137
+
138
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
139
+
140
+ ### Open Link
141
+
142
+ - shortcuts: none
143
+
144
+ Open link to external file (eg. pdf, .mov, etc) use system default
145
+
146
+ <a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
147
+
148
+ * * *
149
+
150
+ ## Hierarchies
151
+
152
+ ### Reload Index
153
+
154
+ - shortcuts: none
155
+
156
+ Reload the index. Necessary for Dendron to pick up on schema changes.
157
+
158
+ ### Archive Hierarchy
159
+
160
+ - shortcuts: none
161
+
162
+ Move current note and all children under the `archive` hierarchy
163
+
164
+ This is a convenience method around `Refactor Hierarchy` for the case of archiving hierarchies you are no longer using. For example, if you were currently at `pro.foo`, running `Archive Hierarchy` would be equivalent to running `Refactor Hierarchy` with the following arguments:
165
+
166
+ - matcher: `pro.foo`
167
+ - replacement: `archive.pro.foo`
168
+
169
+ <a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
170
+
171
+ ### Refactor Hierarchy
172
+
173
+ - shortcuts: none
174
+
175
+ Update hierarchy using regex
176
+
177
+ Like `Rename Note` but works on an entire hierarchy of notes. This command takes two arguments:
178
+
179
+ - matcher: regex that matches text you want to capture for replacement
180
+ - replacer: regex that represents text you want to use as replacement
181
+
182
+ After running the command, you will be taken to a preview that shows all files that will be affected. You will be given an option in a dropdown to either proceed with the refactor or cancel the operation.
183
+
184
+ - NOTE: Dendron will warn you if refactoring will overwrite existing files. You will need to either change your `replacer` or move the affected files before Dendron will perform a refactor
185
+
186
+ Refactor Hierarchy is
187
+ <https://discordapp.com/channels/717965437182410783/743194856788328497/743195382795993291>
188
+
189
+ <a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
190
+
191
+ ### Go Up
192
+
193
+ - shortcuts:
194
+ - mac: `cmd+shift+up`
195
+ - key: `ctrl+shift+up`
196
+ - when: `editorFocus`
197
+
198
+ Go to closet non-stub parent of the currently open note
199
+
200
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
201
+
202
+ ### Go Next Sibling
203
+
204
+ - shortcuts:
205
+ - key: `ctrl+shift+]`
206
+ - when: `editorFocus`
207
+
208
+ Go to the next sibling
209
+
210
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
211
+
212
+ ### Go Previous Sibling
213
+
214
+ - shortcuts:
215
+ - key: `ctrl+shift+[`
216
+ - when: `editorFocus`
217
+
218
+ Go to the previous sibling
219
+
220
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
221
+
222
+ ### Go Down
223
+
224
+ - shortcuts:
225
+ - mac: `cmd+shift+down`
226
+ - key: `ctrl+shift+down`
227
+ - when: `editorFocus`
228
+
229
+ Go down the hierarchy
230
+
231
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
232
+
233
+ * * *
234
+
235
+ ## Workspace
236
+
237
+ ### Vault Add
238
+
239
+ - shortcuts: none
240
+
241
+ Add a new vault
242
+
243
+ When you add a vault, you can choose between adding a local vault or a remote vault. A local vault is a folder in your file system and a remote vault is a git repository. If you choose a remote vault, you can choose from a vault from the registry or enter a custom git url.
244
+
245
+ We currently have two vaults in the registry: `dendron.so` and `aws.dendron.so`. These correspond to the notes backing https://dendron.so/ and https://aws.dendron.so/ respectively.
246
+
247
+ Note that when you add a remote vault, the url can also point to a remote workspace. In that case, dendron will inspect the `dendron.yml` to get a list of all vaults within the workspace and add all vaults from inside the workspace.
248
+
249
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
250
+
251
+ ### Vault Remove
252
+
253
+ - shortcuts: none
254
+
255
+ Remove a vault
256
+
257
+ Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
258
+
259
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
260
+
261
+ ### Initialize Workspace
262
+
263
+ - shortcuts: none
264
+
265
+ Create a new workspace
266
+
267
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workspace-init.gif)
268
+
269
+ ### Change Workspace
270
+
271
+ - shortcuts: none
272
+
273
+ Change into existing workspace
274
+
275
+ ### Snapshot Vault
276
+
277
+ - shortcuts: none
278
+
279
+ Create a snapshot of your vault
280
+
281
+ Takes a snapshot of your entire vault, including assets. This command will ignore version control folders like .git when making a snapshot.
282
+ Snapshots are saved under {workspace}/snapshots/{timestamp}
283
+
284
+ ### Restore Vault
285
+
286
+ - shortcuts: none
287
+
288
+ Restore your vault from a snapshot
289
+
290
+ Restores your vault based on a snapshot. When restoring, it will over-write any notes that have the same name as notes in the snapshot. It will ignore version control directories like .git when restoring your vault
291
+
292
+ ### Show Help
293
+
294
+ - shortcuts: none
295
+
296
+ Dendron will open your current browser to the [[cheatsheet|dendron.cheatsheet]] page.
297
+
298
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
299
+
300
+ ### Configure (yaml)
301
+
302
+ - shortcuts: none
303
+
304
+ Modify Dendron Config as raw YAML
305
+
306
+ ### Configure
307
+
308
+ - shortcuts: none
309
+
310
+ Modify Dendron Config using Dendron UI
311
+
312
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/5b6689eb76344fbb814a3d4405ef62b8" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
313
+
314
+ * * *
315
+
316
+ ## Pods
317
+
318
+ ### Build Pod
319
+
320
+ - shortcuts: none
321
+
322
+ Build your notes for export. Currently, only export to github pages is supported.
323
+
324
+ ### Configure Pod
325
+
326
+ - shortcuts: none
327
+
328
+ Update your pod configuration
329
+
330
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.configure.gif)
331
+
332
+ ### Import Pod
333
+
334
+ - shortcuts: none
335
+
336
+ Import notes from an external data source. Currently, only the local file system is supported
337
+
338
+ ### Export Pod
339
+
340
+ - shortcuts: none
341
+
342
+ Export notes to an external data source. Currently only JSON is supported.
343
+
344
+ <a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
345
+
346
+ ### Publish Pod
347
+
348
+ - shortcuts: none
349
+
350
+ Publish your note to a different format/location
351
+
352
+ ### Copy Note URL
353
+
354
+ - shortcuts:
355
+ - mac: `cmd+shift+u`
356
+ - windows: `ctrl+shift+u`
357
+
358
+ Get URL of current note from published site
359
+
360
+ If you highlight a header, will copy the url with the header set as the anchor
361
+
362
+ The url is taken from the [[siteUrl|dendron.topic.publishing.configuration#siteurl]] property.
363
+
364
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.copy-url.gif)
365
+
366
+ * * *
367
+
368
+ ## Publishing
369
+
370
+ ### Publish
371
+
372
+ - shortcuts: none
373
+
374
+ Build, commit and publish your notes with a single command
375
+
376
+ - NOTE: this is mean for v1 publishing. V2 publishing currently does not have a publish command.
377
+
378
+ <a href="https://www.loom.com/share/c58edf543e234a8fa164095237579ccc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c58edf543e234a8fa164095237579ccc-with-play.gif"> </a>
379
+
380
+ ### Site Build
381
+
382
+ - shortcuts: none
383
+
384
+ Build your notes using publishing v2
385
+
386
+ This command works by running `dendron-cli` in the background.
387
+
388
+ ### Site Preview
389
+
390
+ - shortcuts: none
391
+
392
+ Preview your notes on localhost using publishing v2.
393
+
394
+ This command works by running `dendron-cli` in the background.
395
+
396
+ * * *
397
+
398
+ ## Dev
399
+
400
+ ### Doctor
401
+
402
+ - shortcuts: none
403
+
404
+ Auto fix issues with frontmatter
405
+
406
+ This makes sure your workspace is up to date. It will execute the following actions:
407
+
408
+ - add ids and titles to the frontmatter of all notes that are missing it
409
+ - setup a `docs` folder if it doesn't exist. Required if you want to [[publish|dendron.topic.publishing]] your notes
410
+
411
+ <a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif"> </a>
412
+
413
+ ### Dump State
414
+
415
+ - shortcuts: none
416
+
417
+ Dump internal state of Dendron inside logs
418
+
419
+ This is useful when diagnosing issues in Dendron
420
+
421
+ ### Dendron:Dev: Open Logs
422
+
423
+ - shortcuts: none
424
+
425
+ Open Dendron logs for current session
426
+
427
+ ### Dendron:Dev: Diagnostics Report
428
+
429
+ - shortcuts: none
430
+
431
+ Copy last 3000 lines of all logs and config to clipboard. Use when submitting an issue to Dendron
432
+

Added: vault/dendron.topic.config.md

Files changed (1) hide show
  1. vault/dendron.topic.config.md +226 -0
vault/dendron.topic.config.md ADDED
@@ -0,0 +1,226 @@
1
+ ---
2
+ id: eea2b078-1acc-4071-a14e-18299fc28f48
3
+ title: Config
4
+ desc: ''
5
+ updated: 1615241271952
6
+ created: 1595261816971
7
+ ---
8
+
9
+ Dendron configuration currently lives in two places:
10
+ - Dendron config: `dendron.yml` located at the root of your workspace
11
+ - VSCode config: `dendron.code-workspace`: the vscode workspace file
12
+
13
+ ## Dendron Config
14
+
15
+ ### generateChangelog
16
+ - default: false
17
+ - status: 🚧
18
+
19
+ Turn on to enable [[changelogs|dendron.topic.publishing.changelogs]]
20
+
21
+ ### lookupConfirmVaultOnCreate
22
+
23
+ With this set, you can pick the vault for new notes.
24
+
25
+ ### mermaid
26
+ - default: false
27
+
28
+ Turn on to enable [[mermaid support|dendron.topic.markdown#diagrams]]
29
+
30
+ ### useContainers
31
+ - default: false
32
+
33
+ Turn on to enable [remark-container support](https://github.com/Nevenall/remark-containers)
34
+
35
+ ### useFMTitle
36
+
37
+ When set to true, use frontmatter as title when publishing and in the preview.
38
+
39
+ ### useNoteTitleForLink
40
+
41
+ If true, use the note title when displaying naked links
42
+
43
+ - NOTE: this is not yet fully supported for multi-vault. specifically, cross vault links are not yet supported
44
+
45
+ ### usePrettyRefs
46
+ - default: true
47
+
48
+ If set to false, don't use [[pretty refs|dendron.ref.terms#pretty-ref]]
49
+
50
+ ### vaults
51
+
52
+ Tracks [[vaults|dendron.concepts#vaults]] for the workspace. You shouldn't have to manually edit this value. This is updated automatically when you first initialize a workspace and when you add or remove vaults to your workspace.
53
+
54
+ #### Vault properties:
55
+
56
+ ##### fsPath
57
+ - file path to vault
58
+
59
+ ##### name
60
+ - default: last component of `fsPath`
61
+
62
+ vault name
63
+
64
+ ##### visibility?
65
+ - choices: "private|public"
66
+
67
+ If set to private, notes in this vault will not be published regardless of any other configuration. This takes precedences over everything.
68
+
69
+ ##### remote?
70
+ - added property for [[remote vaults|dendron.concepts#remote-vault]]
71
+ - properties
72
+ - type: currently only `git` is supported (in the future, we might add additional types)
73
+ - url: url to github repo
74
+
75
+
76
+ #### Local Vault Example
77
+ ```yml
78
+ vaults:
79
+ - fsPath: vault
80
+ ```
81
+
82
+
83
+ #### Remote Vault Example
84
+ ```yml
85
+ vaults:
86
+ -
87
+ fsPath: dendron-vault
88
+ remote:
89
+ type: git
90
+ url: 'git@github.com:kevinslin/dendron-vault.git'
91
+ name: dendron
92
+ -
93
+ fsPath: yc-vault
94
+ remote:
95
+ type: git
96
+ url: 'git@github.com:kevinslin/yc-vault.git'
97
+ name: yc
98
+ ```
99
+
100
+
101
+ ## VSCode Config
102
+ ### dendron.dailyJournalDomain
103
+ - type: string
104
+ - default: daily
105
+
106
+ domain where daily journals are kept
107
+
108
+ ### dendron.defaultJournalName
109
+ - type: string
110
+ - default: journal
111
+
112
+ name used for journal notes
113
+
114
+ ### dendron.defaultJournalDateFormat
115
+ - type: string
116
+ - default: y.MM.dd
117
+
118
+ Date format used for journal notes. Use [luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
119
+
120
+ ### dendron.defaultJournalAddBehavior
121
+ - type: string
122
+ - default: childOfDomain
123
+ - options: ['childOfDomain', 'childOfDomainNamespace', 'childOfCurrent', 'asOwnDomain']
124
+
125
+ strategy for adding new journal notes
126
+
127
+ ### dendron.defaultScratchName
128
+ - type: string
129
+ - default: scratch
130
+
131
+ Name used for scratch notes. Date format used for scratch notes. Use [luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
132
+
133
+ ### dendron.defaultScratchDateFormat
134
+ - type: string
135
+ - default: y.MM.dd.HHmmss
136
+
137
+ date format used for scratch notes
138
+
139
+ ### dendron.defaultScratchAddBehavior
140
+ - type: string
141
+ - default: asOwnDomain
142
+ - options: ['childOfDomain', 'childOfDomainNamespace', 'childOfCurrent', 'asOwnDomain']
143
+
144
+ strategy for adding new scratch notes
145
+
146
+
147
+ ### dendron.defaultTimestampDecorationFormat:
148
+ - default: DATETIME_MED
149
+ - type: string
150
+ - values (see description of values [here](https://moment.github.io/luxon/docs/manual/formatting.html))
151
+ * DATETIME_FULL
152
+ * DATETIME_FULL_WITH_SECONDS
153
+ * DATETIME_HUGE
154
+ * DATETIME_HUGE_WITH_SECONDS
155
+ * DATETIME_MED
156
+ * DATETIME_MED_WITH_SECONDS
157
+ * DATETIME_SHORT
158
+ * DATETIME_SHORT_WITH_SECONDS
159
+ * DATE_FULL
160
+ * DATE_HUGE
161
+ * DATE_MED
162
+ * DATE_MED_WITH_WEEKDAY
163
+ * DATE_SHORT
164
+ * TIME_24_SIMPLE
165
+ * TIME_24_WITH_LONG_OFFSET
166
+ * TIME_24_WITH_SECONDS
167
+ * TIME_24_WITH_SHORT_OFFSET
168
+ * TIME_SIMPLE
169
+ * TIME_WITH_LONG_OFFSET
170
+ * TIME_WITH_SECONDS
171
+ * TIME_WITH_SHORT_OFFSET
172
+
173
+ Decide how human readable timestamp decoration is displayed
174
+
175
+ ### dendron.copyNoteUrlRoot
176
+ - type: string
177
+ - default: none
178
+
179
+ override root url when getting note url
180
+
181
+ ### dendron.linkSelectAutoTitleBehavior
182
+ - type: string
183
+ - default: slug
184
+ - options: ['none', 'slug']
185
+
186
+ Control title behavior when using selection2link with lookup
187
+
188
+ ### dendron.defaultLookupCreateBehavior
189
+ - type: string
190
+ - default: selectionExtract
191
+ - options: ['selection2link', 'selectionExtract']
192
+
193
+ when creating a new note with selected text, define behavior for selected text
194
+
195
+ ### dendron.rootDir
196
+ - type: string
197
+ - default:
198
+
199
+ location of dendron workspace
200
+
201
+ ### dendron.dendronDir
202
+ - type: string
203
+ - default:
204
+
205
+ location of dendron configuration
206
+
207
+ ### dendron.logLevel
208
+ - type: string
209
+ - default: info
210
+ - options: ['debug', 'info', 'error']
211
+
212
+ control verbosity of dendron logs
213
+
214
+ ### dendron.trace.server
215
+ - type: string
216
+ - default: messages
217
+ - options: ['off', 'messages', 'verbose']
218
+
219
+ LSP log level
220
+
221
+ ### dendron.serverPort
222
+ - type: number
223
+ - default: none
224
+
225
+ port for server. If not set, will be randomly generated at startup.
226
+

Added: vault/dendron.topic.exports.md

Files changed (1) hide show
  1. vault/dendron.topic.exports.md +12 -0
vault/dendron.topic.exports.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: 1c1a3eac-9937-4e76-b086-bbb1d911517b
3
+ title: Exports
4
+ desc: ''
5
+ updated: 1599574474272
6
+ created: 1599574474272
7
+ stub: false
8
+ ---
9
+ The Dendron Markdown Preview supports HTML, PDF, and export to many different options. You can see [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/html) for the docs.
10
+
11
+ If you would like to export to additional formats our sources, you will (soon) be able to use [[Dendron Export Pods|dendron.topic.pod]] to export your notes anywhere notes can be exported to!
12
+

Added: vault/dendron.topic.extensions.md

Files changed (1) hide show
  1. vault/dendron.topic.extensions.md +31 -0
vault/dendron.topic.extensions.md ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ id: 301e4129-6933-4be7-a4bd-8125171360d8
3
+ title: Extensions
4
+ desc: ''
5
+ updated: 1609795837739
6
+ created: 1596643515473
7
+ stub: false
8
+ ---
9
+ ## Bundled
10
+
11
+ Since Dendron runs on top of VSCode, it means that you also have access to thousands of extensions to customize Dendron exactly how you like it. By default, Dendron will initialize your first workspace with the following extensions and features.
12
+
13
+ - [Dendron Markdown Links](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-links)
14
+ - Graph View
15
+ - [Dendron Markdown Shortcuts](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-shortcuts)
16
+ - Quickly toggle bullet points
17
+ - Easily generate URLs
18
+ - Convert tabular data to tables
19
+ - [Dendron Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-preview-enhanced)
20
+ - live markdown preview
21
+ - math
22
+ - sequence diagrams
23
+ - pandoc support
24
+ - code chunks
25
+ - [Material Theme](https://marketplace.visualstudio.com/items?itemName=equinusocio.vsc-material-theme)
26
+ - beautiful colors built using the [Material design system](https://material.io/)
27
+ - [Dendron Paste Image](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-paste-image)
28
+ - easily add images from your clipboard to your markdown files
29
+
30
+ ((ref:[[dendron.guides.tips]]#other VSCode extensions:#other Browser Extensions))
31
+

Added: vault/dendron.topic.frontmatter.md

Files changed (1) hide show
  1. vault/dendron.topic.frontmatter.md +67 -0
vault/dendron.topic.frontmatter.md ADDED
@@ -0,0 +1,67 @@
1
+ ---
2
+ id: ffec2853-c0e0-4165-a368-339db12c8e4b
3
+ title: Frontmatter
4
+ desc: ''
5
+ updated: 1614665377409
6
+ created: 1595352354163
7
+ stub: false
8
+ ---
9
+ Frontmatter is [YAML](https://yaml.org/) that you can add to the front of your markdown file. It was first introduced by [jekyll](https://jekyllrb.com/docs/front-matter/) and is a convenient way of adding metadata to your plaintext documents.
10
+
11
+ Dendron supports frontmatter. By default, we add the following keys to a new note created with Dendron:
12
+
13
+ - id: a globally unique identifier for the note
14
+ - title: your note title. used to label nodes in [[graph view|dendron.topic.graph-view]]
15
+ - desc: optional description about your note. will show up in lookup results
16
+ - updated: unix timestamp of when note was updated
17
+ - created: unix timestamp of when note was created
18
+
19
+ Frontmatter isn't required in Dendron and Dendron will happily index markdown files without frontmatter. Feel free to add your attributes. As long as it doesn't conflict with a Dendron builtin keyword, Dendron will leave it alone. In the future, we plan on adding a lot more functionality to the frontmatter you see in Dendron so stay tuned.
20
+
21
+ # Reserved Keys
22
+
23
+ Note that not all the keys are written out to the markdown file. Dendron merges the attributes from the markdown frontmatter to its own internal set of attributes.
24
+
25
+ ### id
26
+
27
+ A globally unique identifier for the note.
28
+
29
+ ### title
30
+
31
+ Your note title. used to label nodes in [[graph view|dendron.topic.graph-view]]
32
+
33
+ ### desc
34
+
35
+ Optional description about your note. will show up in lookup results
36
+
37
+ ### updated
38
+
39
+ Unix timestamp of when note was updated
40
+
41
+ ### created
42
+
43
+ Unix timestamp of when note was created
44
+
45
+ ### parent
46
+
47
+ Node parent
48
+
49
+ ### children
50
+
51
+ Node children
52
+
53
+ ### uri
54
+
55
+ Absolute filepath to the note
56
+
57
+ ### data
58
+
59
+ this is reserved for internal use
60
+
61
+ ### custom
62
+
63
+ this is reserved for internal use
64
+
65
+ # Other keys
66
+
67
+ ((ref:[[dendron.topic.publishing.configuration]]#Note Configuration))

Added: vault/dendron.topic.graph-view.md

Files changed (1) hide show
  1. vault/dendron.topic.graph-view.md +41 -0
vault/dendron.topic.graph-view.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: 587e6d62-3c5b-49b0-aedc-02f62f0448e6
3
+ title: Graph View
4
+ desc: ''
5
+ updated: 1610908980098
6
+ created: 1595120707814
7
+ stub: false
8
+ ---
9
+ Dendron provides support for graph view using a fork of the [markdown-links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links) extension.
10
+
11
+ The Dendron graph view is generated using our hierarchical index. It also shows different relationships than most of the graph views you're probably used to.
12
+
13
+ Instead of showing edges as links between nodes, Dendron edges are the hierarchical relationships between your notes. Think of it as a 20,000 foot view of the structure of your knowledge base.
14
+
15
+ Note that this command is not optimized for performance and you might notice slowdowns if you have more than a few hundred notes. If you are running into performance issues, please upvote this [issue](https://github.com/dendronhq/dendron/issues/107) to prioritize the performance work!
16
+
17
+ ## Commands
18
+
19
+ ### Dendron: Show Note Graph
20
+
21
+ Launch the command bar (see [link](https://www.dendron.so/notes/401c5889-20ae-4b3a-8468-269def4b4865.html#launch-the-command-bar) for info): `> Dendron: Show Note Graph`
22
+
23
+ Show your note hierarchies visually in a graph.
24
+
25
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph.show-notes.gif)
26
+
27
+ ### Dendron: Show Schema Graph
28
+
29
+ Launch the command bar (see [link](https://www.dendron.so/notes/401c5889-20ae-4b3a-8468-269def4b4865.html#launch-the-command-bar) for info): `> Dendron: Show Schema Graph`
30
+
31
+ Show your note schemas visually in a graph. Schemas will be labelled by their `title` attribute. If `title` is not set, default to its `id`.
32
+
33
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graphs.show-schema.gif)
34
+
35
+ ### Dendron: Sync Note Graph
36
+
37
+ Updates the note graph with most recent changes
38
+
39
+ ### Dendron: Sync Schema Graph
40
+
41
+ Updates the schema graph with most recent changes

Added: vault/dendron.topic.hierarchies.md

Files changed (1) hide show
  1. vault/dendron.topic.hierarchies.md +106 -0
vault/dendron.topic.hierarchies.md ADDED
@@ -0,0 +1,106 @@
1
+ ---
2
+ id: f3a41725-c5e5-4851-a6ed-5f541054d409
3
+ title: Hierarchies
4
+ desc: ''
5
+ updated: 1595611213607
6
+ created: 1595611213607
7
+ stub: false
8
+ ---
9
+ Within a vault, your notes are stored **hierarchically** as `.` delimited markdown files.
10
+
11
+ Below is a hypothetical hierarchy for a file tree:
12
+
13
+ ```
14
+ .
15
+ └── project1/
16
+ ├── project1/designs/
17
+ │ └── project1/designs/promotion.png
18
+ ├── project1/paperwork/
19
+ │ └── project1/paperwork/legal.md
20
+ └── project1/tasks/
21
+ ├── project1/tasks/task1.md
22
+ └── project1/tasks/task2.md
23
+ ```
24
+
25
+ The same hierarchy in Dendron would look like the following:
26
+
27
+ ```
28
+ .
29
+ ├── project1.md
30
+ ├── project1.designs.md
31
+ ├── project1.designs.promotion.md
32
+ ├── project1.paperwork.md
33
+ ├── project1.paperwork.legal.md
34
+ ├── project1.tasks.md
35
+ ├── project1.tasks.task1.md
36
+ └── project1.tasks.task2.md
37
+ ```
38
+
39
+ ## Concepts
40
+
41
+ In the following concepts, we will be using the following file tree
42
+
43
+ ((ref:[[dendron.ref.layout]]#File Tree,1:#Additional Folders))
44
+
45
+ ### Root
46
+
47
+ Every vault has a root. This is the `root.md`.
48
+
49
+ ### Domain
50
+
51
+ The domain is the root of a specific hierarchy. In our example vault, we have one domain - `dendron`.
52
+
53
+ ## Why Hierarchies?
54
+
55
+ Dendron is built around hierarchies and the axiom that a canonical hierarichal representation of notes is one of the most effective ways of managing large numbers of notes. You can read more about the thoughts behind this [here](https://kevinslin.com/organizing/its_not_you_its_your_knowledge_base/).
56
+
57
+ ## What's with the `.`'s?
58
+
59
+ 1. It allows each **file** to also be a **folder**. This means your notes can have data but also contain other notes.
60
+ 2. It makes it much easier to perform certain refactoring operations. For example, say you had the following [[schema|dendron.topic.schema]]
61
+ ```yml
62
+ - id: a-parent
63
+ children:
64
+ - child-a
65
+ - child-b
66
+ - id: child-a
67
+ - id: child-b
68
+ ```
69
+ Lets say you wanted to make `child-b` a child of `child-a`
70
+ ```yml
71
+ - id: a-parent
72
+ children:
73
+ - child-a
74
+ - id: child-a
75
+ children:
76
+ - child-b
77
+ - id: child-b
78
+ ```
79
+ With the classical folder hierarchy, you would need to turn `child-a` into a folder and then create a custom file to hold the content from the original `child-a`
80
+ ```
81
+ .
82
+ └── a-parent
83
+ └── child-a
84
+ ├── child-a-note
85
+ └── child-b
86
+ ```
87
+ With the `.` delimited hierarchy, this becomes a simple rename operation
88
+ ```
89
+ .
90
+ ├── a-parent.child-a
91
+ └── a-parent.child-a.child-b
92
+ ```
93
+ 3. It allows us to create [[stubs|dendron.topic.schema]] for parts of the hierarchy that don't exist and not clutter our file system with empty folders. With the classical folder hierarchy
94
+ ```
95
+ .
96
+ └── a-parent
97
+ └── child-a
98
+ └── grandchild-a
99
+ └── great-grandchild-a.md
100
+ ```
101
+ With the `.` delimited hierarchy
102
+ ```
103
+ .
104
+ └── a-parent.child-a.grandchild-a.great-grandchild-a.md
105
+ ```
106
+

Added: vault/dendron.topic.images.md

Files changed (1) hide show
  1. vault/dendron.topic.images.md +25 -0
vault/dendron.topic.images.md ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: a91fd8da-6895-49fe-8164-a17acd8d9a17
3
+ title: Images
4
+ desc: ''
5
+ updated: 1595562035825
6
+ created: 1595562035825
7
+ stub: false
8
+ ---
9
+ ## Copy & Paste
10
+
11
+ Dendron automatically inserts images in your clipboard using the `> Paste Image` command. The image is saved to `${currentFileDir}/assets` by default.
12
+
13
+ <a href="https://www.loom.com/share/e1f6d207a1134f42b7a1a7750658acec">
14
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/e1f6d207a1134f42b7a1a7750658acec-with-play.gif"> </a>
15
+ </a>
16
+
17
+ ## Inserting Saved Images
18
+
19
+ An easy way to insert an image which is saved locally to your markdown note is to do the following:
20
+
21
+ - Copy / save the image in your `assets/images` folder located in your vault,
22
+ - In Dendron navigate to the note where you wish to input the image(s), and type:
23
+ - `![Image_Description](assets/images/File_Name.png)`
24
+ - Be sure to replace `Image_Description` and `File_Name.png` with the description of the image and the actual filename
25
+

Added: vault/dendron.topic.imports.md

Files changed (1) hide show
  1. vault/dendron.topic.imports.md +18 -0
vault/dendron.topic.imports.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: 3a9c996b-60d7-4ed9-85bf-cdf3243e9693
3
+ title: Imports
4
+ desc: ''
5
+ updated: 1599596299357
6
+ created: 1599596299357
7
+ stub: false
8
+ ---
9
+ ## Foam
10
+
11
+ Dendron should be compatible with foam notes without any changes.
12
+
13
+ Few things to note though: foam adds "link reference definitions" to the bottom of each file, you might want to remove them since they are not needed in dendron. Also to be able to benefit from dendron hierarchies, you might want to go through each note and think how you want to place them into the hierarchy.
14
+
15
+ ## Roam
16
+
17
+ ## Obsidian
18
+

Added: vault/dendron.topic.keybindings.md

Files changed (1) hide show
  1. vault/dendron.topic.keybindings.md +30 -0
vault/dendron.topic.keybindings.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: c8e99b84-8a5a-42d3-838d-3d5cdebf32e5
3
+ title: Keybindings
4
+ desc: ''
5
+ updated: 1597950074331
6
+ created: 1597950074331
7
+ stub: false
8
+ ---
9
+ Dendron uses VSCode [keybinding](https://code.visualstudio.com/docs/getstarted/keybindings) functionality to define its own keybindings.
10
+
11
+ To update your keybindings, open the command prompt and type `Open Keyboard Shortcuts`.
12
+
13
+ <a href="https://www.loom.com/share/fec07d11a8d949dd98c9ce2ce0bda507">
14
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/fec07d11a8d949dd98c9ce2ce0bda507-with-play.gif"> </a>
15
+
16
+ If you prefer to work with JSON, you can use `Open Keyboard Shortcuts (JSON)`.
17
+
18
+ You can read more about keybinding syntax [here](https://code.visualstudio.com/docs/getstarted/keybindings)
19
+
20
+ # Tips
21
+
22
+ ### Add, Reset and Remove
23
+
24
+ - Add: Every command in VSCode can be bound to a keybinding, even if it doesn't have one
25
+ - Reset: If you want to go back to a default binding, reset it
26
+ - Remove: If you don't use an existing binding, you can remove it
27
+
28
+ <a href="https://www.loom.com/share/ec107e7c70f94070b9a4f52dd88b0899">
29
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/ec107e7c70f94070b9a4f52dd88b0899-with-play.gif"> </a>
30
+

Added: vault/dendron.topic.links.md

Files changed (1) hide show
  1. vault/dendron.topic.links.md +52 -0
vault/dendron.topic.links.md ADDED
@@ -0,0 +1,52 @@
1
+ ---
2
+ id: 3472226a-ff3c-432d-bf5d-10926f39f6c2
3
+ title: Links
4
+ desc: ''
5
+ updated: 1614639285945
6
+ created: 1595003088839
7
+ stub: false
8
+ ---
9
+ Dendron supports multiple types of links and formats.
10
+
11
+ - `[markdown links](./dendron.md)`
12
+ - `[[wiki links]]`
13
+ - `[[labelled|wiki links]]`
14
+ - `![image links](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)`
15
+ - links to `[local files](assets/think.pdf)` (eg. pdfs, psds, etc)
16
+
17
+ ## Wiki Links
18
+
19
+ Wiki links support **autocomplete**. To initiate:
20
+
21
+ - create wikilink brackets and start typing
22
+ - link to specific sections of notes using the `[[wiki link#header]]` syntax.
23
+ - NOTE: relative links will not go to the anchor if clicked on the preview, in that case, it becomes a normal link to the file
24
+ - NOTE2: don't work when exported through a pod
25
+ - use the vscode [intellisense shortcut](https://code.visualstudio.com/docs/editor/intellisense#_key-bindings) to trigger the autocomplete
26
+
27
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/links-autocomplete.gif)
28
+
29
+ ## Backlinks
30
+
31
+ Dendron has a backlink panel which shows all notes with links to the current note.
32
+
33
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/links.backlink.jpg)
34
+
35
+ ## Other Links
36
+
37
+ For links to a file format Dendron does not support, you can use the highlight the link and use `> Dendron: Open Link` to open the file using your operating system default for that file. This also applies to opening paths to folders.
38
+
39
+ <a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
40
+
41
+ ## Cross Vault Links
42
+
43
+ Cross vault links are a way of exactly specifying a note in a [[multi vault|dendron.topic.multi-vault]] workspace. You can turn a regular link into a cross vault link by adding `dendron://$vaultName/` prefix where `$vaultName` is the [[name|dendron.topic.config#name]] of your vault.
44
+
45
+ Some examples:
46
+ - regular wiki link: `[[dendron://vault/foo]]`
47
+ - wiki link with alias: `[[Foo Note|dendron://vault/foo]]`
48
+ - relative link: `[[Foo Note|dendron://vault/foo#header1]]`
49
+
50
+ You can also use cross vault links for [[note references|dendron.topic.refs]].
51
+ - note ref: `![[dendron://vault/foo]]`
52
+

Added: vault/dendron.topic.liquid.md

Files changed (1) hide show
  1. vault/dendron.topic.liquid.md +20 -0
vault/dendron.topic.liquid.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: 1693cee1-3d1d-45b3-a1d2-62a10010ea35
3
+ title: Liquid
4
+ desc: ''
5
+ updated: 1596394978287
6
+ created: 1596394978287
7
+ stub: false
8
+ ---
9
+ You can publish your Dendron notes using Jekyll which has its own templating language called [liquid](https://jekyllrb.com/docs/liquid/). Because of this, published Dendron notes have access to all the templating features of liquid.
10
+
11
+ Note that the templating features won't appear on regular markdown notes but will be rendered when you publish your notes.
12
+
13
+ ## Variables
14
+
15
+ You can use variables defined in the frontmatter inside your page: {{page.created}}.
16
+
17
+ ## Filters
18
+
19
+ You can use filters to transform text. {{ "This title will be modified" | slugify }}
20
+

Added: vault/dendron.topic.lookup.create.md

vault/dendron.topic.lookup.create.md ADDED
@@ -0,0 +1,33 @@
1
+ ---
2
+ id: 0e57f8d1-e501-49db-974c-01eb64c20c22
3
+ title: Creating Notes
4
+ desc: ''
5
+ updated: 1608752992139
6
+ created: 1608494562268
7
+ ---
8
+ ## Summary
9
+
10
+ While we call it the `Lookup Bar`, you can also use it to create notes that don't exist. When you lookup for a note that hasn't been created, Dendron will create it for you.
11
+
12
+ To try it yourself, bring up the lookup bar. Type `hello` and hit `Enter`.
13
+
14
+ ## Creating Special Notes
15
+
16
+ Dendron has builtin notion for certain types of notes with [[pre-defined hierarchies|dendron.topic.special-notes]]. These notes can be created by toggling the corresponding **note button** on the lookup menu or by using the respective builtin shortcuts.
17
+
18
+ - values:
19
+ - none (default): create a regular note
20
+ - journal: create a journal note (cmd/ctrl + shift + j)
21
+ - scratch: create a scratch note (cmd/ctrl + shift + s)
22
+
23
+ ## Creating Notes with a Selection
24
+
25
+ If you have text highlighted while creating a new note with a lookup, the new note will be created using the text selected. How the text will be used depends on the `dendron.defaultLookupCreateBehavior` setting.
26
+
27
+ - values:
28
+ - selectionExtract (default): create new note with text from the old note. remove text from the old note
29
+ - selection2link: create new empty note and turn selection into a link referencing the old note
30
+
31
+ <a href="https://www.loom.com/share/61d754c1dca84b99b2786b2f89473566">
32
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/61d754c1dca84b99b2786b2f89473566-with-play.gif"> </a>
33
+

Added: vault/dendron.topic.lookup.delete.md

vault/dendron.topic.lookup.delete.md ADDED
@@ -0,0 +1,9 @@
1
+ ---
2
+ id: a6f1d6c7-91f3-4c14-9b89-9e66b6276f70
3
+ title: Deleting Notes
4
+ desc: ''
5
+ updated: 1608494857196
6
+ created: 1608494673903
7
+ ---
8
+ To delete `dendron.lookup.hello`, use the `Cmd+Shift+D` shortcut on the note that you want to delete. Alternatively, you can also launch the `Command Bar` and type `Dendron: Delete Node`
9
+

Added: vault/dendron.topic.lookup.find.md

Files changed (1) hide show
  1. vault/dendron.topic.lookup.find.md +17 -0
vault/dendron.topic.lookup.find.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ id: 84a0366a-eab5-4862-9bef-360f92a196dc
3
+ title: Finding Notes
4
+ desc: ''
5
+ updated: 1608494862002
6
+ created: 1608494616703
7
+ ---
8
+ Below is an example of a simple two level hierarchy with notes on various [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) commands. Use `Cmd+L` (we are going to use mac keybindings for this tutorial) to bring up the lookup and try some of the following queries.
9
+
10
+ ```
11
+ - cli.tar
12
+ - cli.curl
13
+ - cli.dig
14
+ ```
15
+
16
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-cli.gif)
17
+

Added: vault/dendron.topic.lookup.keybindings.md

vault/dendron.topic.lookup.keybindings.md ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: 66d734d2-07bd-4ac6-be0b-a38b55bc1099
3
+ title: Keybindings
4
+ desc: ''
5
+ updated: 1608494660278
6
+ created: 1608494646816
7
+ ---
8
+ You can trigger specific lookups using custom key bindings. For example, The following keybinding will trigger lookup set to creating a journal note and turning a selection into a link.
9
+
10
+ ((ref:[[dendron.topic.keybindings]]#keybindings,1))
11
+
12
+ ```json
13
+ {
14
+ "command": "dendron.lookup",
15
+ "key": "cmd+k j",
16
+ "args": {
17
+ "noteType": "journal",
18
+ "selectionType": "selection2link"
19
+ }
20
+ }
21
+ ```
22
+
23
+ <a href="https://www.loom.com/share/1e6b39a93b7245e4b13310f7c06d972f">
24
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/1e6b39a93b7245e4b13310f7c06d972f-with-play.gif"> </a>
25
+

Added: vault/dendron.topic.lookup.md

Files changed (1) hide show
  1. vault/dendron.topic.lookup.md +12 -0
vault/dendron.topic.lookup.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: a7c3a810-28c8-4b47-96a6-8156b1524af3
3
+ title: Lookup
4
+ desc: ''
5
+ updated: 1608495047845
6
+ created: 1595952505038
7
+ stub: false
8
+ ---
9
+ To work with notes, Dendron uses **lookups**. Lookups help you create, find, and organize your notes. You can watch the following video to see some of the things you can do with lookups.
10
+
11
+ <a href="https://www.loom.com/share/a409a621763548d395e48c9d4380cbe7"><img style="" src="https://cdn.loom.com/sessions/thumbnails/a409a621763548d395e48c9d4380cbe7-1600813345789-with-play.gif"> </a>
12
+

Added: vault/dendron.topic.lookup.modifiers.md

vault/dendron.topic.lookup.modifiers.md ADDED
@@ -0,0 +1,117 @@
1
+ ---
2
+ id: ad270a7d-2aed-4273-8319-eb6536e38b29
3
+ title: Modifiers
4
+ desc: ''
5
+ updated: 1608495043297
6
+ created: 1604883459208
7
+ ---
8
+ Modifiers allow you to update the behavior of lookup. You can trigger a modifier by clicking on the modifier icon or passing custom arguments to `dendron.lookup` when defining a custom keyboard shortcut.
9
+
10
+ Modifiers are divided into 6 categories:
11
+
12
+ - filter
13
+ - selection
14
+ - note
15
+ - split
16
+ - effect
17
+ - other
18
+
19
+ ## filterType
20
+
21
+ Filter notes that show up during lookup
22
+
23
+ ### directChildOnly
24
+
25
+ By default, unless you are at the root of your workspace, dendron does a fuzzy search of all notes that match your current hierarchy prefix. This is useful to see your entire sub-tree in one glance but can be overwhelming if you have a lot of notes.
26
+
27
+ Dendron's **directChildFilter** is a toggle that limits lookup to just the next level in the tree. This is useful for exploring your hierarchy one level at a time.
28
+
29
+ - filter all notes that are not the direct children of the current note
30
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.dchild.jpg)
31
+
32
+ <a href="https://www.loom.com/share/45b49b53bf324aeebe387d2ba9515d94">
33
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/45b49b53bf324aeebe387d2ba9515d94-with-play.gif"> </a>
34
+
35
+ ## selectionType
36
+
37
+ Determines behavior of selected text when creating a new note via lookup
38
+
39
+ ### selectionExtract
40
+
41
+ selection is extracted to newly created note (default)
42
+
43
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.selection.jpg)
44
+
45
+ ### selection2link
46
+
47
+ selection is turned into a link to newly created note. note path is set to `{current-path}.{slug-of-selection}`
48
+
49
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.link.jpg)
50
+
51
+ - a [slug](https://stackoverflow.com/questions/19335215/what-is-a-slug) is the human readable portion of an url
52
+ <a href="https://www.loom.com/share/abaa8083d93f4192aa480f1acef1a8b7">
53
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/abaa8083d93f4192aa480f1acef1a8b7-with-play.gif"> </a>
54
+
55
+ - you can control this behavior using `dendron.linkSelectAutoTitleBehavior`
56
+
57
+ ((ref:[[dendron.topic.config]]#dendron.linkselectautotitlebehavior,1:#*))
58
+
59
+ ## noteType
60
+
61
+ Modifies note path
62
+
63
+ ### journal
64
+
65
+ Create a journal note
66
+
67
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.journal.jpg)
68
+
69
+ ### scratch
70
+
71
+ create a scratch note
72
+
73
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.scratch.jpg)
74
+
75
+ ## splitType
76
+
77
+ If set, open note in a new split
78
+
79
+ ### horizontal
80
+
81
+ When opening a note via lookup, you can decide to have the note open in a horizontal split.This works when you're creating new notes or opening an existing note
82
+
83
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.splitType.jpg)
84
+
85
+ <a href="https://www.loom.com/share/814bccbdec384cf094e040f1cc6eebe9">
86
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/814bccbdec384cf094e040f1cc6eebe9-with-play.gif"> </a>
87
+
88
+ ## effectType
89
+
90
+ Effects modify lookup in additional ways that are not covered by the other modification categories
91
+
92
+ ### multiSelect
93
+
94
+ You can toggle multi-select within lookup. This lets you work with multiple notes at once. You can combine this with other modifiers like **splitType** and the **copyWikiLink** modifier.
95
+
96
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/913ff5490ba9445787ff1063be749658" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
97
+
98
+ ### copyWikiLink
99
+
100
+ Copy the results of a lookup as a wikilink.
101
+
102
+ ## Other Modifiers
103
+
104
+ Dendron has a few additional modifiers that can only be set programatically
105
+
106
+ ### noConfirm
107
+
108
+ If set, select first option from lookup without confirmation
109
+
110
+ - type: boolean
111
+
112
+ ### value
113
+
114
+ If set, have a custom value for lookup
115
+
116
+ - type: string
117
+

Added: vault/dendron.topic.lookup.schemas.md

vault/dendron.topic.lookup.schemas.md ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ id: 60c03500-98e4-4a02-a31e-2702b4068a88
3
+ title: Schemas
4
+ desc: ''
5
+ updated: 1608494693843
6
+ created: 1608494693843
7
+ ---
8
+ Dendron also provides lookup for [[schemas|dendron.topic.schema]]. To lookup a schema, use `> Dendron: Lookup Schema` or the `Cmd+Shift+L` (`Ctrl+Shift+L` on windows and linux) shortcut to bring up the schema lookup.
9
+
10
+ ### Finding Schemas
11
+
12
+ The process for finding schemas using Dendron is the same as that for finding notes. One lookup to rule them all.
13
+
14
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
15
+
16
+ ### Creating Schemas
17
+
18
+ Just like with notes, if you enter the name of a schema that does not exist, Dendron will create it for you.
19
+
20
+ Specifically, Dendron will create `{value}.schema.yml` in your vault. At this point, you are free to edit the schema. After you're satisfied with the result, you'll need to run [[> Dendron: Reload Index|dendron.topic.commands]] for it to take affect.
21
+
22
+ - NOTE: if you get an error after running `Reload Index`, it is most likely because your YAML is malformed. You can paste it in [yaml lint](http://www.yamllint.com/) to check that you are using the correct yaml syntax.
23
+
24
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-create.gif)
25
+
26
+ ### Deleting Schemas
27
+
28
+ The process for deleting schemas using Dendron is identical to deleting notes.
29
+

Added: vault/dendron.topic.managed-publishing.md

vault/dendron.topic.managed-publishing.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ id: a6b9c043-7713-48ea-b826-50d003e3e21f
3
+ title: Managed Publishing (NEW)
4
+ desc: ''
5
+ updated: 1615161394505
6
+ created: 1615160515751
7
+ ---
8
+
9
+ This documentation goes over Dendron's managed hosting for publishing your notes
10
+
11
+ ## Related
12
+ - [[2 - Managed Publishing RFC|dendron.rfc.2-managed-publishing]]

Added: vault/dendron.topic.managed-publishing.quickstart.md

vault/dendron.topic.managed-publishing.quickstart.md ADDED
@@ -0,0 +1,92 @@
1
+ ---
2
+ id: 53de5c1e-b20c-4adc-ae48-e1659ecc6d13
3
+ title: Quickstart
4
+ desc: ''
5
+ updated: 1615227076068
6
+ created: 1613009015603
7
+ ---
8
+
9
+ ## Pre-requisites
10
+ - a workspace pushed to Github
11
+ - if you don't have one ready, you can use the [starter template](https://github.com/dendronhq/workspace-sample)
12
+ - create an account on https://app.dendron.so
13
+
14
+ ## Creating a site
15
+ 1. Go to https://app.dendron.so Create an account if you don't already have one.
16
+ 1. After you login, use "publish a site from Github"
17
+ 1. Enter the url of the repo that you want to publish
18
+ 1. Enter a [[personal access token|dendron.rfc.2-managed-publishing.ref.github-token]]
19
+
20
+ When your site is ready, you should see the following screen
21
+
22
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_23_21__3_39_PM.jpg)
23
+
24
+ ### Fine Print
25
+ - Dendron publishes your site at `{username}.dendron.wiki`
26
+
27
+ ### Limitations
28
+ - NOTE: because managed publishing is in early access, the following restrictions currently apply
29
+ <!-- -->
30
+ - one site per account
31
+ - ~~no custom domains~~
32
+ - no multi-vault support
33
+
34
+ ## Deleting a Site
35
+ 1. Click `Site Settings` on the site widget
36
+ 2. Click `Delete`
37
+
38
+
39
+ ## Adding a custom domain via CNAME
40
+
41
+ - this feature is limited to [[environmentalist|dendron.community.roles#environmentalist]]
42
+
43
+ ### Pre-prequisites
44
+
45
+ - have a domain that you own and control the CNAME records for
46
+ - have your github repo hooked up to dendron (see [[Creating a site|dendron.topic.managed-publishing.quickstart#creating-a-site]])
47
+
48
+ ### Steps
49
+ 1. Decide on a CNAME that you want to use. Lets call this YOUR_CNAME
50
+ 1. Email support@dendron.so with the subject: `CNAME Request: YOUR_CNAME`
51
+ 1. You'll get a response with a custom CNAME entry. Add that to your DNS (instructions to do this will depend on your registrar)
52
+ ```
53
+ _5e6e3c15a64565a3fbd9609d390e06d4.www.awschangelog.com. to _1fcefb9e363e5ebc64d8bc7ad6f31535.nfyddsqlcy.acm-validations.aws.
54
+ ```
55
+ 1. Update YOUR_CNAME to point to `hosting.dendron.wiki`
56
+ 1. Email support@dendron.so with the subject: `CNAME Request: YOUR_CNAME - UPDATED`
57
+ 1. You'll get a response from support@dendron.so that your account is now ready for custom domains
58
+ 1. Push to the repository that you have configured with managed publishing. Dendron will now connect your repository with your CNAME
59
+ - NOTE: the link to view the site will still be pointed to `$username.dendron.wiki`. You'll need to manually add your CNAME to see the changes
60
+ <!-- 1. Go to `app.dendron.so` and update your published site with the CNAME -->
61
+
62
+ ### Limitations
63
+ - custom domains with CNAMES doesn't work with apex domains (these are domains without a prefix - eg. foo.com is an apex domain, www.foo.com is not)
64
+ - if you are interested in using an apex domain, see the guide below
65
+
66
+ ## Add a custom domain via delegating name servers
67
+ - this feature is limited to [[environmentalist|dendron.community.roles#environmentalist]]
68
+
69
+ ### Pre-prequisites
70
+
71
+ - have a domain that you own and control the name server records for
72
+ - have your github repo hooked up to dendron (see [[Creating a site|dendron.topic.managed-publishing.quickstart#creating-a-site]])
73
+
74
+ ### Steps
75
+ 1. Email support@dendron.so with the subject: `NS Request: YOUR_DOMAIN`
76
+ - example: `NS Request: kevin.xyz`
77
+ 1. You'll get a response with a custom NS entry. Add that to your DNS (instructions to do this will depend on your registrar)
78
+ - example response
79
+ ```
80
+ ns-1986.awsdns-48.co.uk.
81
+ ns-738.awsdns-28.net.
82
+ ns-1484.awsdns-52.org.
83
+ ns-298.awsdns-37.com.
84
+ ```
85
+ 1. Update your domain nameserver with the results
86
+ - WARNING: if you are currently serving traffic via the domain, this will cause your website to be temporarily un-availble
87
+ - NOTE: save your current name servers as backup for when you want to revert this process
88
+ 1. Email support@dendron.so with the subject: `NS Request: YOUR_DOMAIN - UPDATED`
89
+ 1. You'll get a response from support@dendron.so that your account is now ready for custom domains
90
+ 1. Push to the repository that you have configured with managed publishing. Dendron will now connect your repository with your CNAME
91
+ - NOTE: the link to view the site will still be pointed to `$username.dendron.wiki`. You'll need to manually add your CNAME to see the changes
92
+

Added: vault/dendron.topic.markdown.md

Files changed (1) hide show
  1. vault/dendron.topic.markdown.md +321 -0
vault/dendron.topic.markdown.md ADDED
@@ -0,0 +1,321 @@
1
+ ---
2
+ id: ba97866b-889f-4ac6-86e7-bb2d97f6e376
3
+ title: Markdown
4
+ desc: ''
5
+ updated: 1614058664647
6
+ created: 1598673110284
7
+ ---
8
+ - Notice: all references of `MPE` in this guide is in reference to `Dendron Markdown Preview Enhanced`, the default markdown renderer of Dendron
9
+
10
+ ## Markdown Basics
11
+
12
+ This article is a brief introduction to [GitHub Flavored Markdown writing](https://guides.github.com/features/mastering-markdown/).
13
+
14
+ ## What is Markdown?
15
+
16
+ `Markdown` is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like `#` or `*`.
17
+
18
+ ## Syntax guide
19
+
20
+ ### Headers
21
+
22
+ ```markdown
23
+ # This is an <h1> tag
24
+
25
+ ## This is an <h2> tag
26
+
27
+ ### This is an <h3> tag
28
+
29
+ #### This is an <h4> tag
30
+
31
+ ##### This is an <h5> tag
32
+
33
+ ###### This is an <h6> tag
34
+ ```
35
+
36
+ ### Emphasis
37
+
38
+ <!-- prettier-ignore -->
39
+
40
+ ```markdown
41
+ *This text will be italic*
42
+ _This will also be italic_
43
+
44
+ **This text will be bold**
45
+ __This will also be bold__
46
+
47
+ _You **can** combine them_
48
+
49
+ ~~This text will be strikethrough~~
50
+ ```
51
+
52
+ ### Lists
53
+
54
+ #### Unordered List
55
+
56
+ ```markdown
57
+ - Item 1
58
+ - Item 2
59
+ - Item 2a
60
+ - Item 2b
61
+ ```
62
+
63
+ #### Ordered List
64
+
65
+ ```markdown
66
+ 1. Item 1
67
+ 1. Item 2
68
+ 1. Item 3
69
+ 1. Item 3a
70
+ 1. Item 3b
71
+ ```
72
+
73
+ #### Definition List
74
+
75
+ ```markdown
76
+ Item 1
77
+ : Definition for Item 1
78
+
79
+ Item 2
80
+ ~ Definition for Item 2
81
+ ~ Another definition for Item 2, with a [link](http://www.example.com)
82
+ ```
83
+
84
+ ### Images
85
+
86
+ ```markdown
87
+ ![GitHub Logo](/images/logo.png)
88
+ Format: ![Alt Text](url)
89
+ ```
90
+
91
+ ### Links
92
+
93
+ ```markdown
94
+ https://github.com - automatic!
95
+ [GitHub](https://github.com)
96
+ ```
97
+
98
+ ### Blockquote
99
+
100
+ ```markdown
101
+ As Kanye West said:
102
+
103
+ > We're living the future so
104
+ > the present is our past.
105
+ ```
106
+
107
+ ### Horizontal Rule
108
+
109
+ ```markdown
110
+ Three or more...
111
+
112
+ ---
113
+
114
+ Hyphens
115
+
116
+ ---
117
+
118
+ Asterisks
119
+
120
+ ---
121
+
122
+ Underscores
123
+ ```
124
+
125
+ ### Inline code
126
+
127
+ ```markdown
128
+ I think you should use an
129
+ `<addr>` element here instead.
130
+ ```
131
+
132
+ ### Fenced code block
133
+
134
+ You can create fenced code blocks by placing triple backticks <code>\`\`\`</code> before and after the code block.
135
+
136
+ #### Syntax Highlighting
137
+
138
+ You can add an optional language identifier to enable syntax highlighting in your fenced code block.
139
+
140
+ For example, to syntax highlight Ruby code:
141
+
142
+ ````
143
+ ```ruby
144
+ require 'redcarpet'
145
+ markdown = Redcarpet.new("Hello World!")
146
+ puts markdown.to_html
147
+ ```
148
+ ````
149
+
150
+ ```ruby
151
+ require 'redcarpet'
152
+ markdown = Redcarpet.new("Hello World!")
153
+ puts markdown.to_html
154
+ ```
155
+
156
+ ### Task lists
157
+
158
+ ```markdown
159
+ - [x] list syntax required (any unordered or ordered list supported)
160
+ - [x] this is a complete item
161
+ - [ ] this is an incomplete item
162
+ ```
163
+
164
+ ## Extended Syntax
165
+
166
+ These are non-standard markdown syntax used in Dendron. Everything here is both available in Dendron's preview as well as when publishing.
167
+
168
+ ### Tables
169
+
170
+ You can create tables by assembling a list of words and dividing them with hyphens `-` (for the first row), and then separating each column with a pipe `|`:
171
+
172
+ <!-- prettier-ignore -->
173
+
174
+ ```markdown
175
+ First Header | Second Header
176
+ ------------ | -------------
177
+ Content from cell 1 | Content from cell 2
178
+ Content in the first column | Content in the second column
179
+ ```
180
+
181
+ You can create a table from existing content using `> Markdown Shortcuts: Add Table` command.
182
+
183
+ ![](https://raw.githubusercontent.com/mdickin/vscode-markdown-shortcuts/master/media/demo/table_with_header.gif)
184
+
185
+ ### Abbreviation
186
+
187
+ The HTML specification
188
+
189
+ ```markdown
190
+ _[HTML]: Hyper Text Markup Language
191
+ _[W3C]: World Wide Web Consortium
192
+ The HTML specification
193
+ is maintained by the W3C.
194
+ ```
195
+
196
+ ### Footnotes
197
+
198
+ ```markdown
199
+ Content [^1]
200
+
201
+ [^1]: Hi! This is a footnote
202
+ ```
203
+
204
+ ### Frontmatter Variable Substitution
205
+
206
+ You can use variables defined in your note frontmatter inside your note. The syntax is `{{fm.VAR_NAME}}` where `VAR_NAME` is the name of your variable. The `fm` designates that you want to use a frontmatter variable.
207
+
208
+ ### Nunjuck Templates
209
+ - status: EXPERIMENTAL
210
+
211
+ You can use a limited set of [nunjucks](https://mozilla.github.io/nunjucks/) to customize your notes.
212
+
213
+ To enable, you can set the following to true inside your `dendron.yml`.
214
+ ```yml
215
+ useNunjucks: true
216
+ ```
217
+
218
+ Once enabled, you'll have access to nunjucks specific constructs. You'll have the same variables available as during [[frontmatter variable substitution|dendron.topic.markdown#frontmatter-variable-substitution]]. Nunjucks templates also get access to the `fname` builtin variable which will be substituted with the filename of the current note.
219
+
220
+ Below is an example of what you can do with nunjucks.
221
+
222
+ - Raw Markdown
223
+ ```md
224
+ ## Variables
225
+
226
+ - special variables: {{fname}}
227
+ - special variable as link: [[{{fname}}]]
228
+ - special variable as note ref: ![[{{fname}}#footer]]
229
+
230
+ ## Loops
231
+
232
+ {% for item in fm.alist %}
233
+
234
+ - Item: {{item}}
235
+ {% endfor %}
236
+
237
+ ## Footer
238
+
239
+ This is some footer content
240
+ ```
241
+
242
+ - Compiled
243
+ ![nunjucks example](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.nunjucks.jpg)
244
+
245
+
246
+ Nunjucks will work for both the preview and for publishing. It is still an experimental feature which means it might change in backwards in-compatible ways at any point.
247
+
248
+ It currently also has the following limitations:
249
+ - disables live preview of markdown (you'll need to refresh the markdown to see changes)
250
+ - will throw an error if you currently have nunjucks like strings inside your notes `eg. {% %}`
251
+ - will throw errors if you refer to an undefined variable `{{ foo }}`
252
+
253
+ ### Diagrams
254
+
255
+ Dendron lets you create Diagrams using [mermaid](https://mermaid-js.github.io/mermaid/#/)
256
+ Create a code block with mermaid support to use mermaid. The following block turns into the diagram below.
257
+
258
+ <pre>
259
+ ```mermaid
260
+ graph TD;
261
+ A-->B;
262
+ A-->C;
263
+ B-->D;
264
+ C-->D;
265
+ ```
266
+ </pre>
267
+
268
+
269
+ ```mermaid
270
+ graph TD;
271
+ A-->B;
272
+ A-->C;
273
+ B-->D;
274
+ C-->D;
275
+ ```
276
+
277
+ - NOTE: in order to publish diagrams, you'll need to enable [[mermaid in the config|dendron.topic.config#mermaid-optional]]
278
+
279
+ ## VSCode Specific Commands
280
+
281
+ ### Markdown Smart Select
282
+
283
+ This allows you to expand and shrink selections of markdown using a keyboard shortcut.
284
+
285
+ - Expand: ⌃⇧⌘→
286
+ - Shrink: ⌃⇧⌘←
287
+
288
+ Selection applies to the following, and follows a traditional hierarchical pattern:
289
+
290
+ - Headers
291
+ - Lists
292
+ - Block quotes
293
+ - Fenced code blocks
294
+ - Html code blocks
295
+ - Paragraphs
296
+
297
+ ![preview](https://code.visualstudio.com/assets/updates/1_51/markdown-smart-select-demo.gif)
298
+
299
+ > Image by Microsoft
300
+
301
+ ## Compatibility with CommonMark
302
+
303
+ [CommonMark](https://commonmark.org/) is _a strongly defined, highly compatible specification of Markdown_
304
+
305
+ When possible, Dendron will try to stay to `CommonMark` spec for syntax. That being said, many of the features we have (eg. block based note references) have no common mark equivalent which is why we've had to invent new syntax.
306
+
307
+ You can use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to migrate both individual notes and your entire vault to a CommonMark compatible format.
308
+
309
+ ## Other Resources
310
+
311
+ - [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
312
+ - [Daring Fireball: Markdown Basics](https://daringfireball.net/projects/markdown/basics)
313
+ - [Markdown Guide](https://www.markdownguide.org/)
314
+
315
+ ## References
316
+
317
+ The content of this page is derived from the following sources:
318
+
319
+ 1. [markdown preview enhanced docs](https://shd101wyy.github.io/markdown-preview-enhanced/#/markdown-basics) published under the [University of Illinois/NCSA Open Source License](https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/LICENSE.md)
320
+ 2. [markdown shortcuts docs](https://marketplace.visualstudio.com/items?itemName=mdickin.markdown-shortcuts) published under the [MIT License](https://marketplace.visualstudio.com/items/mdickin.markdown-shortcuts/license)
321
+

Added: vault/dendron.topic.math.md

Files changed (1) hide show
  1. vault/dendron.topic.math.md +38 -0
vault/dendron.topic.math.md ADDED
@@ -0,0 +1,38 @@
1
+ ---
2
+ id: b1919663-cc48-4054-b0cf-4b26fe444907
3
+ title: Math
4
+ desc: ''
5
+ updated: 1609036928368
6
+ created: 1609036713270
7
+ ---
8
+ Dendron uses [Katex](https://katex.org/) to render math.
9
+
10
+ - Expressions inside `$...$` will be rendered using inline format.
11
+ - Expressions inside `$$...$$` will be rendered using block format.
12
+
13
+ ## Examples
14
+
15
+ ### Inline
16
+
17
+ ```
18
+ $f(x) = sin(x)$
19
+ ```
20
+
21
+ will render as
22
+
23
+ $f(x) = sin(x)$
24
+
25
+ ### Block
26
+
27
+ ```
28
+ $$
29
+ f(x) = sin(x)
30
+ $$
31
+ ```
32
+
33
+ will render as
34
+
35
+ $$
36
+ f(x) = sin(x)
37
+ $$
38
+

Added: vault/dendron.topic.md

Files changed (1) hide show
  1. vault/dendron.topic.md +11 -0
vault/dendron.topic.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 7a7af2fa-b9d0-4adc-81e6-f03186123539
3
+ title: Topics
4
+ desc: ''
5
+ updated: 1595606002784
6
+ created: 1595606002784
7
+ stub: false
8
+ nav_order: 4
9
+ ---
10
+
11
+

Added: vault/dendron.topic.ovsx.md

Files changed (1) hide show
  1. vault/dendron.topic.ovsx.md +14 -0
vault/dendron.topic.ovsx.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ id: 9134f160-31a6-4ab0-a640-1fce466f9526
3
+ title: Open VSX
4
+ desc: ''
5
+ updated: 1597006851049
6
+ created: 1597006851049
7
+ stub: false
8
+ ---
9
+ Dendron and all its recommended extensions are published on the [open vsx](https://open-vsx.org/) registry. This means that Dendron can now be run on all VSCode compatible editors. The list of editors that Dendron **should** be compatible on is listed below:
10
+
11
+ - [VSCodium](https://github.com/VSCodium/vscodium)
12
+ - [Theia](https://theia-ide.org/)
13
+ - [Code Server](https://github.com/cdr/code-server)
14
+

Added: vault/dendron.topic.pod.builtin.json.md

vault/dendron.topic.pod.builtin.json.md ADDED
@@ -0,0 +1,179 @@
1
+ ---
2
+ id: 28dfaaf8-4944-447c-be30-39c514a80bb0
3
+ title: JSON Pod
4
+ desc: ''
5
+ updated: 1610233180012
6
+ created: 1603306959022
7
+ ---
8
+
9
+ ## Summary
10
+ - id: `dendron.json`
11
+ - coverage
12
+ - ✅ import
13
+ - ✅ export
14
+ - ✅ publish
15
+
16
+ ### Import
17
+
18
+ Imports a JSON file as Dendron notes
19
+
20
+ - format:
21
+ - fname: name of note (without extension)
22
+ - body: contents of note
23
+ - eg:
24
+
25
+ ```json
26
+ [
27
+ {
28
+ "fname": "one",
29
+ "body": "one body"
30
+ }
31
+ ]
32
+ ```
33
+
34
+ <a href="https://www.loom.com/share/375b64a6597346ec8e6be5ca35049194"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/375b64a6597346ec8e6be5ca35049194-with-play.gif"> </a>
35
+
36
+ #### Export
37
+
38
+ Below is sample output from an export of a vault with the following files
39
+
40
+ ```
41
+ .
42
+ └── vault
43
+ ├── root.md
44
+ ├── sample.child.md
45
+ └── sample.md
46
+ ```
47
+
48
+ Exported JSON
49
+
50
+ ```json
51
+ [
52
+ {
53
+ "id": "root",
54
+ "title": "root",
55
+ "desc": "",
56
+ "type": "note",
57
+ "updated": 1599430958377,
58
+ "created": 1599430958377,
59
+ "fname": "root",
60
+ "data": {},
61
+ "stub": false,
62
+ "custom": {},
63
+ "parent": null,
64
+ "children": [
65
+ "01d712a3-3676-403c-87d7-f3e7057ca43e",
66
+ "01d712a3-3676-403c-87d7-f3e7057ca43e"
67
+ ]
68
+ },
69
+ {
70
+ "id": "01d712a3-3676-403c-87d7-f3e7057ca43e",
71
+ "title": "Sample",
72
+ "desc": "",
73
+ "type": "note",
74
+ "updated": 1599430965554,
75
+ "created": 1599430965554,
76
+ "fname": "sample",
77
+ "data": {},
78
+ "stub": false,
79
+ "custom": {
80
+ "tags": [
81
+ "one",
82
+ "two",
83
+ "three"
84
+ ]
85
+ },
86
+ "parent": "root",
87
+ "children": [
88
+ "1d947d6e-39c4-4d31-9bec-749a467fc514"
89
+ ]
90
+ },
91
+ {
92
+ "id": "1d947d6e-39c4-4d31-9bec-749a467fc514",
93
+ "title": "Child",
94
+ "desc": "",
95
+ "type": "note",
96
+ "updated": 1599430969355,
97
+ "created": 1599430969355,
98
+ "fname": "sample.child",
99
+ "data": {},
100
+ "stub": false,
101
+ "custom": {
102
+ "customProp": "yellow",
103
+ "customStat": 5
104
+ },
105
+ "parent": "01d712a3-3676-403c-87d7-f3e7057ca43e",
106
+ "children": []
107
+ }
108
+ ]
109
+ ```
110
+
111
+ Video example of exporting to JSON
112
+
113
+ <a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
114
+
115
+ ### Publish Pod
116
+
117
+ Publish notre to JSON and copy into clipboard
118
+
119
+ Sample output
120
+
121
+ ```json
122
+ {
123
+ "id": "814f9a2c-f011-4852-a077-c887dd985656",
124
+ "title": "Two",
125
+ "type": "note",
126
+ "desc": "",
127
+ "links": [
128
+ {
129
+ "type": "wiki",
130
+ "from": {
131
+ "fname": "bar.two",
132
+ "id": "814f9a2c-f011-4852-a077-c887dd985656"
133
+ },
134
+ "original": "bar.two.child",
135
+ "value": "bar.two.child",
136
+ "alias": "bar.two.child",
137
+ "pos": {
138
+ "start": 23,
139
+ "end": 40
140
+ },
141
+ "to": {
142
+ "fname": "bar.two.child"
143
+ }
144
+ },
145
+ {
146
+ "type": "wiki",
147
+ "from": {
148
+ "fname": "bar.two",
149
+ "id": "814f9a2c-f011-4852-a077-c887dd985656"
150
+ },
151
+ "original": "bar.two.child",
152
+ "value": "bar.two.child",
153
+ "alias": "bar.two.child",
154
+ "pos": {
155
+ "start": 50,
156
+ "end": 67
157
+ },
158
+ "to": {
159
+ "fname": "bar.two.child"
160
+ }
161
+ }
162
+ ],
163
+ "fname": "bar.two",
164
+ "updated": 1603305706789,
165
+ "created": 1602872932440,
166
+ "parent": "93f6a3ad-2b0f-4843-9b65-961c65de9237",
167
+ "children": [
168
+ "8e19c23d-4335-4684-846e-ca7fed893b51"
169
+ ],
170
+ "body": "\n\n# Inner Note\n\n((ref: [[bar.two.child]]))\n((ref: [[bar.two.child]]))",
171
+ "data": {},
172
+ "custom": {},
173
+ "schema": {
174
+ "schemaId": "bar",
175
+ "moduleId": "bar"
176
+ }
177
+ }
178
+ ```
179
+

Added: vault/dendron.topic.pod.builtin.markdown.md

vault/dendron.topic.pod.builtin.markdown.md ADDED
@@ -0,0 +1,71 @@
1
+ ---
2
+ id: 13c4a608-0a32-4c62-9c7e-2b7f9f2d18bf
3
+ title: Markdown Pod
4
+ desc: ''
5
+ updated: 1610233214080
6
+ created: 1603306941128
7
+ ---
8
+
9
+ ## Summary
10
+ - id: `dendron.markdown`
11
+ - coverage
12
+ - export
13
+ - ✅ import
14
+ - ✅ publish
15
+
16
+ ### Import
17
+
18
+ Import markdown files stored locally.
19
+
20
+ The pod finds all files from the `root`, and copies over the files into your vault, cleaning the file names to fit dendron's naming hierarchy. You can see an example below.
21
+
22
+ - Original
23
+
24
+ ```
25
+ .
26
+ └── projects
27
+ ├── p1
28
+ │ ├── one.md
29
+ │ ├── two.md
30
+ │ └── one.pdf
31
+ └── p2
32
+ ├── three.md
33
+ ├── four.md
34
+ └── three.gif
35
+ ```
36
+
37
+ - After Import
38
+
39
+ ```
40
+ .
41
+ └── vault
42
+ ├── assets
43
+ │ ├── one-{uuid}.pdf
44
+ │ └── three-{uuid}.gif
45
+ ├── projects.p1.md
46
+ ├── projects.p1.one.md
47
+ ├── projects.p1.two.md
48
+ ├── projects.p2.md
49
+ ├── projects.p2.three.md
50
+ └── projects.p2.four.md
51
+ ```
52
+
53
+ Non-markdown files within a directory will be moved into the `assets` folder of your `vault`. A [uuid](https://en.wikipedia.org/wiki/Universally_unique_identifier) will be added to non-markdown file names to ensure it does not overwrite any existing files. A link of the original filenames will be made in the note that corresponds to the imported directory
54
+
55
+ ```md
56
+ ...
57
+ # Imported Assets
58
+ - [one.pdf](assets/one-c91d4cb3-1db8-4703-884f-c4f5f9a00734.pdf)
59
+
60
+ ```
61
+
62
+ Note that all files starting with a `.` will be ignored during the import.
63
+
64
+ #### Links
65
+
66
+ If you are importing from tools like **Obsidian** that support wiki-links, Dendron will convert those wiki-links to Dendron's dot based format (eg. `[[project/p1]] -> [[project.p1]]`)
67
+
68
+ ### Publish
69
+
70
+ Publish Dendron Markdown to regular markdown. Convert note references and dendron specific syntax to regular markdown.
71
+

Added: vault/dendron.topic.pod.builtin.md

Files changed (1) hide show
  1. vault/dendron.topic.pod.builtin.md +20 -0
vault/dendron.topic.pod.builtin.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: 3e519113-5820-4a84-bef8-85103a7b296b
3
+ title: Builtin Pods
4
+ desc: ''
5
+ updated: 1610233223346
6
+ created: 1603306628504
7
+ toc: true
8
+ ---
9
+
10
+ ## Summary
11
+ Builtin pods are managed by Dendron and are available when you install Dendron. They can be used with either the `dendron-cli` or from within the Dendron extension to import/export/publish your notes from/to anywhere
12
+
13
+ ## JSON Pod
14
+
15
+ ![[dendron.topic.pod.builtin.json#summary:#*]]
16
+
17
+ ## Markdown Pod
18
+
19
+ ![[dendron.topic.pod.builtin.markdown#summary,1:#*]]
20
+

Added: vault/dendron.topic.pod.custom.md

Files changed (1) hide show
  1. vault/dendron.topic.pod.custom.md +40 -0
vault/dendron.topic.pod.custom.md ADDED
@@ -0,0 +1,40 @@
1
+ ---
2
+ id: 6322a2de-34fd-4c93-bcbe-d71c30e5f2b6
3
+ title: Custom Pods
4
+ desc: ''
5
+ updated: 1614312977869
6
+ created: 1603308868151
7
+ ---
8
+
9
+ ## Summary
10
+
11
+ <!-- - STATUS: DRAFT
12
+ - NOTE: this documentation is for future functionality. It is not currently implemented. Progress can be tracked in this [issue](https://github.com/dendronhq/dendron/issues/286). -->
13
+
14
+ Custom pods can be developed by anyone as a `NodeJS` package and used after a user installs it in their workspace. They can be used with either the `dendron-cli` or from within the Dendron extension to import/export/publish your notes from/to anywhere
15
+
16
+ - NOTE: at the current time, custom pods can only be run using `dendron-cli`. We're working on building them into the plugin within the next couple of weeks
17
+ - NOTE: currently, only custom pods for **publishing** is supported. We're working on adding support for `import` and `export` pods
18
+
19
+
20
+ ## Quickstart (Using a custom pod)
21
+
22
+ Run the following inside your Dendron workspace.
23
+
24
+ ### Install a Pod
25
+
26
+ ```bash
27
+ cd {workspace}
28
+ npm init -y
29
+ npm install -g dendron-cli
30
+ npm install --save {dendron-pod-package}
31
+ ```
32
+
33
+ ### Execute a Pod (CLI)
34
+
35
+ ```bash
36
+ dendron-cli publishPod --wsRoot . --podId {podId} --podPkg {npmPkg} --podSource custom --config {podConfig}
37
+ ```
38
+
39
+ ## List of Custom Pods
40
+ - [[Dev.to Pod|dendron.pro.devto-pod]]: publish notes to dev.to

Added: vault/dendron.topic.pod.dev.md

Files changed (1) hide show
  1. vault/dendron.topic.pod.dev.md +161 -0
vault/dendron.topic.pod.dev.md ADDED
@@ -0,0 +1,161 @@
1
+ ---
2
+ id: 5de219e6-d9b9-4abf-9367-998109cd57cd
3
+ title: Developing a Pod
4
+ desc: ''
5
+ updated: 1614965542487
6
+ created: 1614201272488
7
+ ---
8
+ ## Summary
9
+
10
+ - status: WORK_IN_PROGRESS 🚧
11
+
12
+ In this module, we'll go over how to create a custom pod. You can clone the end result [here](https://github.com/dendronhq/hello-pod)
13
+
14
+ ## Pre-requisites
15
+
16
+ - Install dendron-cli
17
+ ![[dendron.topic.cli#installation,1:#*]]
18
+ - [[Install Dendron|dendron.guides.install#install]] and have a workspace initialized
19
+
20
+ ## Tutorial
21
+
22
+ ### Create your pod
23
+
24
+ - NOTE: this tutorial goes over developing using javascript. All Dendron packages are typed and can also be developed using typescript
25
+
26
+ ```sh
27
+ mkdir hello-pod
28
+ npm init -y
29
+ npm install --save @dendronhq/pods-core
30
+ touch index.js
31
+ ```
32
+
33
+ Open index.js and add the following
34
+
35
+ ```js
36
+ const { PublishPod } = require("@dendronhq/pods-core");
37
+
38
+ class HelloPod extends PublishPod {
39
+ static id = "hello";
40
+ static description = "Add a hello statement";
41
+
42
+ async plant(opts) {
43
+ const { note } = opts;
44
+ const body = note.body;
45
+ return ["Hello World", body].join("\n");
46
+ }
47
+ }
48
+
49
+ module.exports = {
50
+ pods: [HelloPod],
51
+ };
52
+ ```
53
+
54
+ ## Testing your pod
55
+
56
+ 1. Create a symlink of your current package. This lets you use your package locally in other projects
57
+ ```sh
58
+ npm link
59
+ ```
60
+ 2. Go to your [[workspace root|dendron.ref.layout#workspace-root]].
61
+ ```sh
62
+ cd $WORKSPACE_ROOT
63
+ ```
64
+ 3. If you don't have a `package.json` already , create one by running `npm init -y`
65
+ ```sh
66
+ npm init -y
67
+ ```
68
+ 4. Link to your created pod
69
+ ```sh
70
+ npm link hello-pod
71
+ ```
72
+ 5. Excecute your pod
73
+ ```sh
74
+ dendron-cli publishPod --wsRoot . --podId hello --podPkg hello-pod --podSource remote --config fname=dendron,vaultName=vault,dest=stdout
75
+ ```
76
+ - since I was running this in a new Dendron vault, I got the following output
77
+
78
+ ```markdown
79
+ Hello World
80
+
81
+ ## The Trail 🥾
82
+
83
+ Here are the basics of Dendron so you can get started growing your knowledge base.
84
+ - [ ] Create your first note.
85
+ - [ ] Dendron uses the [lookup](https://www.dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#lookup-menu) command to create. So, hit CMD+L (or ctrl+L if you're on Windows) to bring up the lookup bar, type in a new note name and hit enter to create it. You can also run the lookup command through the command palette "Dendron: Lookup".
86
+ - [ ] Wiki-style links are supported. If the note doesn't exist, we'll create the note for you. For example, just try [[this link]] from the editor view.
87
+ - [ ] Find your notes. Dendron really shines when you need to look up notes quickly. For this, you use *drumroll* the lookup command (again). Just hit CMD/ctrl+L and you can search your entire set of notes.
88
+ - [ ] To delete a note, navigate to it and use the "Dendron: Delete Node" command. As with everything else in VSCode, bring up the command palette with CMD/ctrl+shift+P and run the command.
89
+ - [ ] Use a [snippet](https://www.dendron.so/notes/9eca1992-7540-4d9d-97fb-328b27748b2c.html) for quick note templates
90
+ - [ ] Insert an [image](https://www.dendron.so/notes/a91fd8da-6895-49fe-8164-a17acd8d9a17.html)
91
+ - [ ] Create some [links](https://www.dendron.so/notes/3472226a-ff3c-432d-bf5d-10926f39f6c2.html)
92
+ - [ ] [Publish](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html) your vault
93
+ - [ ] Join us on [discord](https://discord.com/invite/6j85zNX) and discuss all things knowledge management with your fellow trail blazers.
94
+ - [ ] For more information, see Dendron's basic [concepts](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html)
95
+ ```
96
+
97
+ ### Pass in custom configuration values
98
+
99
+ We're going to make our publishing a little more dynamoc by using custom configuration.
100
+
101
+ Modify your pod to accept a new configuration parameter
102
+
103
+ ```js
104
+ const { PublishPod } = require("@dendronhq/pods-core");
105
+
106
+ class HelloPod extends PublishPod {
107
+ static id = "hello";
108
+ static description = "Add a hello statement";
109
+
110
+ get config() {
111
+ return super.config.concat([
112
+ {
113
+ key: "name",
114
+ description: "dev.to api key",
115
+ type: "string",
116
+ },
117
+ ]);
118
+ }
119
+
120
+ async plant(opts) {
121
+ const { note, config } = opts;
122
+ const body = note.body;
123
+ return [`Hello ${config.name}`, body].join("\n");
124
+ }
125
+ }
126
+
127
+ module.exports = {
128
+ pods: [HelloPod],
129
+ };
130
+
131
+ ```
132
+
133
+ Below is a diff to make the changes a bit more obvious.
134
+ ![diff of code](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-change.jpg)
135
+
136
+ Run the pod again the the additional argument.
137
+
138
+ ````
139
+ ```sh
140
+ dendron-cli publishPod --wsRoot . --podId hello --podPkg hello-pod --podSource remote --config fname=dendron,vaultName=vault,dest=stdout,name=Albert
141
+ ```
142
+ ````
143
+
144
+ ```markdown
145
+ Hello Albert
146
+
147
+ ## The Trail 🥾
148
+ ...
149
+ ```
150
+
151
+ ### Use Note Metadata
152
+
153
+ Pods have full access to all the metadata attached to a note. You can see the pod arguments below
154
+ ![[dendron.topic.pod.sdk#plantopts-publishpodplantoptst,1]]
155
+
156
+ TODO - You can see an example of this [[here|dendron.pro.devto-pod]]
157
+
158
+ ### Using Typescript
159
+
160
+ TODO - You can see an example of this [[here|dendron.pro.devto-pod]]
161
+

Added: vault/dendron.topic.pod.md

Files changed (1) hide show
  1. vault/dendron.topic.pod.md +55 -0
vault/dendron.topic.pod.md ADDED
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: 66727a39-d0a7-449b-a10d-f6c438185d7f
3
+ title: Pods
4
+ desc: ''
5
+ updated: 1614190960609
6
+ created: 1602958663144
7
+ ---
8
+ <img src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.png" height="300px"/>
9
+
10
+ > Pod image courtesy of [Ilana Lin](https://www.instagram.com/ilana_lin/)
11
+
12
+ Dendron refers to pods as any tool or location that is used to hold information. Tools like Evernote and Roam are pods. Social media services like Twitter and Facebook are pods. Publication destinations like static sites and Medium are pods. Everything is a pod.
13
+
14
+ Pods let you do the following:
15
+
16
+ - **import** your notes from any existing location into Dendron
17
+ - **export** your notes from Dendron to any existing location
18
+ - **publish** your notes from Dendron to any existing location
19
+
20
+ To access pods, Dendron exposes three commands:
21
+
22
+ - `Dendron: Import Pod`: imports notes
23
+ - `Dendron: Export Pod`: export notes
24
+ - `Dendron: Publish Pod`: publish notes
25
+
26
+ **NOTE**: not all pods will expose all three commands. Each pod implementation can choose to implement any subset of the three commands.
27
+
28
+ ## Pod Methods
29
+
30
+ ### Import
31
+
32
+ Importing lets you bulk import notes from a given source and into Dendron. The notes are formatted and converted to Dendron's hierarchal structure.
33
+
34
+ ### Export
35
+
36
+ Exporting lets you bulk export notes from Dendron into another destinations. The notes will be formatted and converted to the native format of the destination.
37
+
38
+ ### Publish
39
+
40
+ Publishing lets you take one note and output it into a different format/destination.
41
+
42
+ For example, you might want to use our [[markdown pod|dendron.topic.pod.builtin.markdown]] to take a note with [[note references|dendron.topic.refs]] and publish it as a regular markdown note to use in a github issue or another tool.
43
+
44
+ Future uses of the **publish** method will be taking a note and publishing it to social media (eg. twitter, facebook, linkedin), publishing it to Gmail, and publishing to destinations like Medium and dev.to.
45
+
46
+ ## Types of Pods
47
+
48
+ There are two types of pods:
49
+
50
+ - builtin: created by dendron
51
+ - remote: created by third parties
52
+
53
+ ![[dendron.topic.pod.builtin#summary,1:]]
54
+ ![[dendron.topic.pod.custom#summary,1:]]
55
+

Added: vault/dendron.topic.pod.sdk.md

Files changed (1) hide show
  1. vault/dendron.topic.pod.sdk.md +36 -0
vault/dendron.topic.pod.sdk.md ADDED
@@ -0,0 +1,36 @@
1
+ ---
2
+ id: 6301a5b4-d88f-4ecd-ad72-0880b1bf14b0
3
+ title: Sdk Reference
4
+ desc: ''
5
+ updated: 1614215063307
6
+ created: 1614214703771
7
+ ---
8
+
9
+
10
+ ## PublishPod
11
+
12
+ Base class to be extended when creating a pod for [[publishing|dendron.topic.pod#publish]]
13
+
14
+ ### plant(opts: PublishPodPlantOpts<T>)
15
+ - opts
16
+ - engine: DEngineClientV2
17
+ - config: PublishPodConfig
18
+ - note: NotePropsV2
19
+ ```ts
20
+ export type NotePropsV2 = {
21
+ id: string;
22
+ title: string;
23
+ desc: string;
24
+ links: DLink[];
25
+ fname: string;
26
+ updated: string;
27
+ created: string;
28
+ parent: DNodePointerV2 | null;
29
+ children: DNodePointerV2[];
30
+ body: string;
31
+ custom?: any;
32
+ schema?: { moduleId: string; schemaId: string };
33
+ vault: DVault;
34
+ ...
35
+ };
36
+ ```

Added: vault/dendron.topic.preview.md

Files changed (1) hide show
  1. vault/dendron.topic.preview.md +23 -0
vault/dendron.topic.preview.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: 8de4209d-84d3-45f8-96a4-34282e34507d
3
+ title: Preview
4
+ desc: ''
5
+ updated: 1603383860949
6
+ created: 1603383580067
7
+ ---
8
+ The preview pane renders the Dendron's markdown text into nicely formatted HTML. The preview is a fork of the [markdown-preview-enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced).
9
+
10
+ All documentation pertaining to the original extension can be found [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/). This page will highlight some key features as well as Dendron specific additions.
11
+
12
+ ### Table of Contents
13
+
14
+ You can toggle a table of contents from the preview pane using a button toggle.
15
+
16
+ <a href="https://www.loom.com/share/516b862bc30b49edbff3239632e35f90">
17
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/516b862bc30b49edbff3239632e35f90-with-play.gif"> </a>
18
+
19
+ ### Issues
20
+
21
+ - Preview does not persist between reloads/restarts
22
+ - Workaround: [Always show preview of md being edited](./dendron.guides.tips.md#always-show-preview-of-md-being-edited)
23
+

Added: vault/dendron.topic.publishing-legacy.commands.md

vault/dendron.topic.publishing-legacy.commands.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 90a86fc3-4ea1-4596-a6d5-247fe0213b1c
3
+ title: Commands
4
+ desc: ''
5
+ updated: 1600575510386
6
+ created: 1600575510386
7
+ stub: false
8
+ nav_order: 3.5
9
+ ---
10
+ ((ref:[[dendron.topic.commands]]#publishing,1:#Dev))
11
+

Added: vault/dendron.topic.publishing-legacy.configuration.md

vault/dendron.topic.publishing-legacy.configuration.md ADDED
@@ -0,0 +1,270 @@
1
+ ---
2
+ id: ffa6a4ba-5eda-48c7-add5-8e2333ba27b4
3
+ title: Configuration
4
+ desc: ''
5
+ updated: 1613770983668
6
+ created: 1600564020051
7
+ nav_order: 3
8
+ ---
9
+ Dendron lets you control publication behavior at three levels:
10
+
11
+ - **globally** through `dendron.yml` configuration
12
+ - **per note** through the publication related frontmatter
13
+ - **per line** through custom dendron directives inside the note
14
+
15
+ ## Global Configuration
16
+
17
+ The `dendron.yml` configuration file controls what notes get published. It is located at the root of your workspace.
18
+
19
+ ```
20
+ .
21
+ └── {workspace}
22
+ └── dendron.yml
23
+ ```
24
+
25
+ Below is the config that is used to publish `dendron.so` from the contents of this [repo](https://github.com/dendronhq/dendron-template)
26
+
27
+ ```yml
28
+ site:
29
+ siteHierarchies: [dendron]
30
+ siteRootDir: docs
31
+ ```
32
+
33
+ ### Properties
34
+
35
+ #### assetsPrefix?:
36
+
37
+ Prefix for assets.
38
+
39
+ - NOTE: By default, assets are served from the root. If you are publishing to github pages and followed the instructions [here](https://pages.github.com/) by creating a repo named `{username}.github.io`, then no further action is needed. This is because github will make your site available at `https://{username}.github.io`. If you created a custom repo, you will need to set the prefix to the name of your repo because github will make your site available at `https://username.github.io/{your-repo-name/}`
40
+
41
+ #### copyAssets
42
+
43
+ - required: no
44
+ - type: boolean
45
+ - default: true
46
+
47
+ Copy assets from vault to site.
48
+
49
+ #### siteHierarchies: str\[]
50
+
51
+ List of hierarchies to publish
52
+
53
+ #### siteIndex?: str
54
+
55
+ - optional, path of your index (home page)
56
+ - defaults to the first element of `siteHierarchies`
57
+
58
+ #### siteRootDir
59
+
60
+ Location of the directory where site will be build. Relative to your workspace
61
+
62
+ #### siteRepoDir
63
+
64
+ - required: no
65
+ - type: string
66
+
67
+ Location of the github repo where your site notes are located. By default, this is assumed to be your `workspaceRoot` if not set. This is used with the `Publish Notes` command
68
+
69
+ #### usePrettyRefs
70
+
71
+ - default: True
72
+
73
+ Whether to use pretty note refs or plain refs.
74
+
75
+ #### config
76
+
77
+ Per hierarchy specific config. To set options for **all** hierarchies, set `{hiearchy name}` to **root**.
78
+
79
+ ```yml
80
+ config:
81
+ {hierarchy name}: {hierarchy options}
82
+ ```
83
+
84
+ The list of possible options:
85
+
86
+ - **publishByDefault**: boolean, default: true
87
+ - if set to false, dendron will only publish notes within the hierarchy that have `published: true` set in the frontmatter
88
+ - **noindexByDefault**: boolean, default: false
89
+ - if set to true, dendron will add the following meta tag `<meta name="robots" content="noindex, nofollow”>` which will tell google to not index your page
90
+ - when google indexes a page, it will penalize sites that have duplicate content from other sites. this is useful if you are using your hiearchy as a [[cache|dendron.workflows.cache]]
91
+ - **customFrontmatter**: list, default: \[]
92
+ - if set, dendron will add the specified frontmatter to each published note in the hierarchy. note that this will override existing keys with the same name when publishing
93
+ - eg. add `toc: true` to all notes published under the `iam.*` hierarchy
94
+ ```yml
95
+ config:
96
+ iam:
97
+ customFrontmatter: [
98
+ {
99
+ key: "toc",
100
+ value: true,
101
+ }
102
+ ]
103
+ ```
104
+
105
+ ### Examples
106
+
107
+ #### Blog
108
+
109
+ Below is the config for [kevinslin.com](https://kevinslin.com). It publishes everything under the `home` and `blog` hierarchies but will only publish notes under `books` if `published: true` is set on the frontmatter.
110
+
111
+ - dendron.yml
112
+
113
+ ```yml
114
+ site:
115
+ siteHierarchies: [home, blog, books]
116
+ siteRootDir: docs
117
+ config:
118
+ books:
119
+ publishByDefault: false
120
+ ```
121
+
122
+ #### Example publishing entire vault
123
+
124
+ - vault
125
+
126
+ ```
127
+ .
128
+ ├── root.md
129
+ ├── dendron.md
130
+ ├── dendron.quickstart.md
131
+ ├── dendron.zen.md
132
+ ├── flowers.md
133
+ └── flowers.bud.md
134
+ ```
135
+
136
+ - dendron.yml
137
+
138
+ ```yml
139
+ publish:
140
+ siteHierarchies: [root]
141
+ ```
142
+
143
+ - what gets published
144
+
145
+ ```
146
+ .
147
+ └── root.md
148
+ ├── dendron
149
+ │ ├── dendron.quickstart
150
+ │ └── dendron.zen
151
+ └── flowers
152
+ └── flowers.bud
153
+ ```
154
+
155
+ #### Example publishing just one domain
156
+
157
+ - vault
158
+
159
+ ```
160
+ .
161
+ ├── root.md
162
+ ├── dendron.md
163
+ ├── dendron.quickstart.md
164
+ └── dendron.zen.md
165
+ ```
166
+
167
+ - dendron.yml
168
+
169
+ ```yml
170
+ publish:
171
+ siteHierarchies: [dendron]
172
+ ```
173
+
174
+ - published:
175
+
176
+ ```
177
+ .
178
+ └── dendron
179
+ ├── dendron.quickstart
180
+ └── dendron.zen
181
+ ```
182
+
183
+ ## Vault Configuration
184
+
185
+ The following needs to be set in the [[vaults|dendron.topic.config#vaults]] section of the config.
186
+
187
+ ![[dendron.topic.config#visibility:#*]]
188
+
189
+ ## Note Configuration
190
+
191
+ You can specify how notes are published via the frontmatter of each note.
192
+
193
+ ### Properties
194
+
195
+ #### published
196
+
197
+ - type: boolean
198
+ - default: true
199
+
200
+ To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
201
+
202
+ ```yml
203
+ ...
204
+ published: false
205
+ ```
206
+
207
+ #### noindex
208
+
209
+ - type: boolean
210
+ - default: true
211
+
212
+ To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
213
+
214
+ ```yml
215
+ ...
216
+ noindex: true
217
+ ```
218
+
219
+ #### toc
220
+
221
+ - type: boolean
222
+ - default: false
223
+
224
+ To generate a table of contents in a given note, enable this directive in the note frontmatter.
225
+
226
+ ```yml
227
+ toc: true
228
+ ```
229
+
230
+ You will also need to include the following line somewhere in the note body. Dendron will generate a table of contents when it finds that particular header
231
+
232
+ ```md
233
+ ## Table of Contents
234
+ ```
235
+
236
+ The output will look like the below.
237
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.toc.jpg)
238
+
239
+ - NOTE: in order to generate a table of contents, the heading levels after ToC need to be at an equal level or greater than the heading level of `Table of Contents`
240
+ - this is okay
241
+ ```markdown
242
+ ## Table of Contents
243
+ ## Header1
244
+ ## Header2
245
+ ```
246
+ - this is not
247
+ ```markdown
248
+ ## Table of Contents
249
+ ### Header1
250
+ ### Header2
251
+ ```
252
+
253
+ ## Line Configuration
254
+
255
+ You can control publication on a per line basis.
256
+
257
+ ## Properties
258
+
259
+ ### LOCAL_ONLY_LINE
260
+
261
+ Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
262
+
263
+ ```markdown
264
+ Hello World! <!-- Will be published -->
265
+
266
+ This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
267
+ ```
268
+
269
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
270
+

Added: vault/dendron.topic.publishing-legacy.local-preview.md

vault/dendron.topic.publishing-legacy.local-preview.md ADDED
@@ -0,0 +1,66 @@
1
+ ---
2
+ id: 63b184f7-1901-4580-af40-97ef87069a04
3
+ title: Local Preview
4
+ desc: ''
5
+ updated: 1600740884846
6
+ created: 1600740884846
7
+ stub: false
8
+ nav_order: 2.1
9
+ ---
10
+ > The following guide was created by fellow Dendronite [Ed](https://github.com/ens100)!
11
+
12
+ In order to publish your notes, we have included a brief step by step guide to get you started.
13
+
14
+ In a nutshell, we need to:
15
+
16
+ - Install Ruby
17
+ - Install Jekyll
18
+ - Set up the environment
19
+ - Publish our notes
20
+ - Enjoy the fruits of our labor
21
+
22
+ Although these may seem complex, I hope the following guide will assist and make things as simple as possible.
23
+
24
+ ## Installing Ruby
25
+
26
+ Ruby version 2.5.0 or higher is needed, so open a Terminal window (eg. PowerShell / cmd) and type `ruby -v`. If the error message "_ruby : The term 'ruby' is not recognized_" comes up do the following:
27
+
28
+ - Navigate [here](https://rubyinstaller.org/downloads/) and download the recommended **Ruby+Devkit** and then open the downloaded file.
29
+ - When the installation is complete you will see an option to Run `ridk install`. Make sure this is checked as it is needed for installing Jekyll and click finish.
30
+ - A terminal window will open asking what components to install - Simply press the `enter` key to install the default components.
31
+ - Close the terminal and reopen a new iteration to ensure that the Path variables have been set.
32
+ - In the newly opened Terminal run `ruby -v` and you should get `ruby 2.6.6p146 (2020-03-31 revision 67876) [x64-mingw32]` or similar back.
33
+
34
+ ## Installing Jekyll
35
+
36
+ - From the Terminal type `gem install jekyll bundler` and let it run until finished (takes a few minutes).
37
+ - When completed run `jekyll -v` and the Terminal should return with something like: `jekyll 4.1.1`.
38
+
39
+ Step 1 and 2 over and done with.
40
+
41
+ ## Setting up the Environment
42
+
43
+ - In the Terminal navigate to the `docs` folder within your dendron vault.
44
+ - The easiest way to do this is to copy the location of the folder in File Explorer and then go to the Terminal and type `cd ` and paste the copied text and then click enter.
45
+ - Run `bundle install`
46
+
47
+ We are approaching the finishing line.
48
+
49
+ ## Publishing Our Notes
50
+
51
+ In order for our notes / markdown files to be published we need to carry out the following steps:
52
+
53
+ - From within Dendron, run the "Build Pod" command by clicking `ctrl + Shift + P` and typing Pod. This will bring up the option `> Dendron: Build Pod`, select it and click enter.
54
+ - In the bottom right hand side after a few seconds you should see "finished".
55
+
56
+ ## Last Step
57
+
58
+ - Open the terminal and type `bundle exec jekyll serve`
59
+ - This will run a configuration to generate the markdown files to static pages so that they can be viewed online.
60
+ - Once the above step is completed, open a web browser and navigate to `http://localhost:4000/`.
61
+ - You should see a copy of your notes using a similar theme as this one.
62
+
63
+ You will be able to see any changes you do to your notes in Dendron on the localhost.
64
+
65
+ Think this deserves a high five!
66
+

Added: vault/dendron.topic.publishing-legacy.md

vault/dendron.topic.publishing-legacy.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ id: 73d395c9-5041-4d0d-9db7-080d9586136e
3
+ title: Publishing Legacy
4
+ desc: ''
5
+ updated: 1613875845679
6
+ created: 1595170096361
7
+ stub: true
8
+ nav_exclude: true
9
+ ---
10
+ Dendron lets you publish the contents of your vault, either in its entirety or only a subset. Notes are published under the [dendron-jekyll theme](https://github.com/dendronhq/dendron-jekyll).
11
+
12
+ You can find documentation about the theme [[here|dendron.pro.dendron-jekyll]]
13
+
14
+ - NOTE: Jekyll based publishing is now DEPRECATED. We encourage everyone to move to [[Publishing V2|dendron.topic.publishing]]
15
+

Added: vault/dendron.topic.publishing-legacy.quickstart.md

vault/dendron.topic.publishing-legacy.quickstart.md ADDED
@@ -0,0 +1,35 @@
1
+ ---
2
+ id: c800d576-789c-4a68-ac03-a66efd40d39b
3
+ title: Quickstart
4
+ desc: ''
5
+ updated: 1600564090683
6
+ created: 1600564090683
7
+ stub: false
8
+ nav_order: 2
9
+ ---
10
+ NOTE: it's possible to publish Dendron on any platform that can host static sites. This guide covers publishing to [Github Pages](https://pages.github.com/)
11
+
12
+ ### Pre-requisites
13
+
14
+ - Create an account on [github](https://github.com/)
15
+ - Follow the instructions [here](https://pages.github.com/) to create a repository named `{username}.github.io` where `{username}` is your username on Github
16
+ - Setup a github repo with [github pages enabled](https://guides.github.com/features/pages/)
17
+ - when selecting the source, make sure to pick `master branch/docs folder`
18
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/gh-page-docs.jpg)
19
+ - Create an initial commit and push your vault to your github page
20
+
21
+ ### Guide
22
+
23
+ 1. Depending on what notes you want to publish, you will want to update your `dendron.yml` file. By default, everything will be published
24
+ 2. Update the contents of `_config.yml` inside your `docs` folder to specify site wide configuration like logo and title.
25
+ - NOTE: this is located relative to `dendron.rootDir`
26
+ - if you do not have a `docs` folder, you can run `Dev:Dendron: Doctor` to create one
27
+ 3. When you are ready to publish, run the `> Dendron: Build Pod` command to prepare your site for publication. This builds your notes into the `siteRootDir` directory which defaults to `docs`. `Build Pod` does the following when it builds your site:
28
+ - copies over the notes specified in `dendron.yml`
29
+ - creates a copy of your notes with the ids in place of the file names
30
+ - updates all `wiki-links` to `markdown-links` so Jekyll can process it, preserving titles if there are any
31
+ 4. Commit your changes.
32
+ 5. Push your repository using `> Git: Push`
33
+
34
+ <a href="https://www.youtube.com/watch?v=VOZJxKg0-js">![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron-publishing.jpg)</a>
35
+

Added: vault/dendron.topic.publishing.advanced.md

vault/dendron.topic.publishing.advanced.md ADDED
@@ -0,0 +1,57 @@
1
+ ---
2
+ id: e9f26a4b-ddce-41b3-9619-8f4f64761f86
3
+ title: Advanced
4
+ desc: ''
5
+ updated: 1614535629477
6
+ created: 1600564193281
7
+ ---
8
+ ### Exclude from publication
9
+
10
+ To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
11
+
12
+ ```yml
13
+ ...
14
+ published: false
15
+ ```
16
+
17
+ ### Exclude from indexing
18
+
19
+ To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
20
+
21
+ ```yml
22
+ ...
23
+ noindex: true
24
+ ```
25
+
26
+ <!-- ### Exclude line from publication
27
+
28
+ Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
29
+
30
+ ```markdown
31
+ Hello World! <!-- Will be published -->
32
+
33
+ This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
34
+ ``` -->
35
+
36
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
37
+
38
+ <!-- ### Link Checking
39
+
40
+ It's useful to check if all your links work before publishing your notes. You can use the [awesome-bot](https://github.com/dkhamsing/awesome_bot) gem to validate your links.
41
+
42
+ - setup
43
+ - create a folder named `reports` to hold the results
44
+ ```
45
+ cd {wsRoot}
46
+ mkdir reports
47
+ ```
48
+ - add `reports` to your vscode workspace in order to browse it via vscode
49
+
50
+ - check links
51
+ - build your site using the `Build Pod` command
52
+ - start a local server
53
+ - run the following command
54
+ ```bash
55
+ cd {wsRoot}/reports && awesome_bot ../docs/_site/notes/*.html --allow-redirect --allow-dupe --allow 429
56
+ ```
57
+ -->

Added: vault/dendron.topic.publishing.blogging.md

vault/dendron.topic.publishing.blogging.md ADDED
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: 6d21fd60-e564-4a55-b4c0-d2586293b908
3
+ title: Blogging
4
+ desc: ''
5
+ updated: 1614547898424
6
+ created: 1614547017272
7
+ ---
8
+
9
+
10
+ You can use Dendron for blogging. To do so, add [[collection specific options |dendron.topic.publishing.configuration#collection-options]] to your frontmatter.
11
+
12
+
13
+ ### Using Collections
14
+
15
+ The following frontmatter results in the page [here](https://www.kevinslin.com/notes/b9bc4aa1-4369-446d-91a9-13d4f2a4b8e5.html).
16
+
17
+ ```yml
18
+ has_collection: true
19
+ sort_by: date
20
+ sort_order: reverse
21
+ ```
22
+
23
+ The original hierarchy :
24
+
25
+ ```sh
26
+ blog.thoughts.md
27
+ blog.thoughts.2021-02-03-foo.md
28
+ blog.thoughts.2021-02-03-bar.md
29
+ ...
30
+ ```
31
+
32
+ ### Using Journal Notes
33
+ You can also designate a journal hierarchy as a collection. The following frontmatter is responsible for the page [here](https://www.kevinslin.com/notes/eda0b03c-270c-4c49-9080-46bd8eb55a1e.html)
34
+
35
+ ```yml
36
+ has_collection: true
37
+ sort_by: date
38
+ sort_order: reverse
39
+ skipLevels: 2
40
+ ```
41
+
42
+ The original hierarchy :
43
+
44
+ ```sh
45
+ dendron.md
46
+ dendron.journal.md
47
+ dendron.journal.2021.02.01.md
48
+ dendron.journal.2021.02.02.md
49
+ dendron.journal.2021.02.03.md
50
+ ...
51
+ ```

Added: vault/dendron.topic.publishing.changelogs.md

vault/dendron.topic.publishing.changelogs.md ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ id: e1b84d7e-9b0d-4616-917f-f3af1e7541b0
3
+ title: Changelogs
4
+ desc: ''
5
+ updated: 1615241456334
6
+ created: 1615241095799
7
+ ---
8
+
9
+ ## Summary
10
+ - status: 🚧
11
+
12
+ Dendron can now generate a changelog for your published site. Note that this feature is currently experimental and will only generate the changelog for your latest commit. It also requires that you be using `git` to store your notes. When enabled, this will add `Changelog` to your nav bar which will have your most recent commit.
13
+
14
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_3_8_21__2_05_PM.jpg)
15
+
16
+ ## Enable Changelogs
17
+
18
+ Update `dendron.yml`
19
+ ![[dendron.topic.config#generatechangelog:#*]]
20
+
21
+ ## Limitations
22
+
23
+ The current version of changelogs is deliberately limited as we are iterating on the feature. Currently it will only generate a diff based off the latest local git commit. It also assumes that your entire workspace is versioned using one git repo.
24
+
25
+ ## FAQ
26
+
27
+ ### How is this different from a `git diff`?
28
+
29
+ The changelog view will only show the diff of any public notes

Added: vault/dendron.topic.publishing.collections.md

vault/dendron.topic.publishing.collections.md ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: e4ea4fe3-0350-492e-863a-687d9fc15993
3
+ title: Collections
4
+ desc: ''
5
+ updated: 1614538231995
6
+ created: 1609433737726
7
+ ---
8
+ Sometimes, you might want to publish a page that has all its children listed like in a blog archive format.
9
+
10
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.collection.jpg)
11
+
12
+ This format is called a `collection` in Dendron. You can designate that a page be published as a collection by setting the [[has_collection|dendron.topic.publishing.configuration#has_collection]] property in the note frontmatter.
13
+
14
+ You can see an example of it [here](https://www.kevinslin.com/notes/e9c72b4f-adb8-4f15-a6aa-9f9d81538561.html).
15
+
16
+ ## Sorting
17
+
18
+ Sorting is by the `created` attribute by default. If you wish to set an override, you can add a `date` attribute in `YYYY-MM-DD` format (eg. `date: '2019-08-08'`)
19
+
20
+ You can control sort order via the [[sort_order|dendron.topic.publishing.configuration#sort_order]] attribute.
21
+
22
+ ## Skip Levels
23
+
24
+ ![[dendron.topic.publishing.configuration#skiplevels,1:#*]]
25
+

Added: vault/dendron.topic.publishing.configuration.md

vault/dendron.topic.publishing.configuration.md ADDED
@@ -0,0 +1,453 @@
1
+ ---
2
+ id: f2ed8639-a604-4a9d-b76c-41e205fb8713
3
+ title: Configuration
4
+ desc: ''
5
+ updated: 1614655770757
6
+ created: 1608528797892
7
+ nav_order: 3
8
+ ---
9
+ ## Summary
10
+
11
+ Dendron lets you control publication behavior at multiple levels:
12
+
13
+ - **globally** using `dendronConfig.site`
14
+ - **per hiearchy** through `dendronConfig.site.config`
15
+ - **per note** through the publication related frontmatter
16
+ - **per line** through custom dendron directives inside the note
17
+
18
+ ## Global Configuration
19
+
20
+ The `dendron.yml` configuration file controls what notes get published. It is located at the root of your workspace.
21
+
22
+ ```
23
+ .
24
+ └── {workspace}
25
+ └── dendron.yml
26
+ ```
27
+
28
+ Below is the config that is used to publish `dendron.so` from the contents of this [repo](https://github.com/dendronhq/dendron-template)
29
+
30
+ ```yml
31
+ site:
32
+ siteHierarchies: [dendron]
33
+ siteRootDir: docs
34
+ ```
35
+
36
+ ### assetsPrefix (optional)
37
+
38
+ - default: none
39
+
40
+ Prefix for assets.
41
+
42
+ - NOTE: By default, assets are served from the root. If you are publishing to github pages and followed the instructions [here](https://pages.github.com/) by creating a repo named `{username}.github.io`, then no further action is needed. This is because github will make your site available at `https://{username}.github.io`. If you created a custom repo, you will need to set the prefix to the name of your repo because github will make your site available at `https://username.github.io/{your-repo-name/}`
43
+
44
+ ### copyAssets (optional)
45
+
46
+ - default: true
47
+
48
+ Copy assets from vault to site.
49
+
50
+ ### customHeaderPath (optional)
51
+
52
+ If set, set path to a custom header file (relative to your workspace root) which will be included in all your published pages
53
+
54
+ ```yml
55
+ site:
56
+ ...
57
+ customHeaderPath: header.html
58
+ ```
59
+
60
+ - header.html
61
+
62
+ ```
63
+ <script> console.log("hello world"); </script>
64
+ ```
65
+
66
+ ### duplicateNoteBehavior (optional)
67
+
68
+ When publishing in multi-vault scenario, how to handle duplicate notes
69
+
70
+ Currently, only the `useVault` option is allowed. It takes a list of [[vault names|dendron.topic.config#name]]. When a duplicate is found, Dendron will go throw the vaults in your list from left to right and resolve to the first one that matches.
71
+
72
+ - NOTE: this is done automatically when you run the [[Vault Add|dendron.topic.commands#vault-add]] command
73
+
74
+ ```yml
75
+ duplicateNoteBehavior:
76
+ action: "useVault"
77
+ payload: [{vault1}, {vault2}, {vault3}]
78
+ ```
79
+
80
+ ### ga_tracking (optional)
81
+
82
+ Your ga tracking number if you want to add google analytics.
83
+
84
+ - NOTE: won't be included in `dev` preview
85
+
86
+ ### githubCname (optional)
87
+
88
+ - default: none
89
+
90
+ Cname used for github pages
91
+
92
+ ### logo (optional)
93
+
94
+ - default: none
95
+ - eg: `vault/assets/images/logo.png`
96
+
97
+ Used to add a logo image for all headers
98
+
99
+ ### siteFaviconPath (optional)
100
+
101
+ - default: "favicon.ico"
102
+
103
+ Path to favicon. Relative to workspace.
104
+
105
+ ### siteHierarchies (required)
106
+
107
+ - default: [root]
108
+
109
+ List of hierarchies to publish. `root` is a special value that means `publish all`.
110
+
111
+ ### siteLastModified (optional)
112
+
113
+ - default: false
114
+
115
+ If set to true, show a last modified at the bottom of your site. This value is set form the `updated` timestamp in your note frontmatter.
116
+
117
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.last-modified.jpg)
118
+
119
+ ### siteIndex (optional)
120
+
121
+ - default: first element of `siteHiearchies`
122
+
123
+ Path of your index (home page)
124
+
125
+ ### siteProtocol (optional)
126
+
127
+ - default: https
128
+
129
+ Website protocol
130
+
131
+ ### siteRootDir (required)
132
+
133
+ - default: "docs"
134
+
135
+ Location of the directory where site will be build. Relative to your workspace
136
+
137
+ ### siteRepoDir (optional)
138
+
139
+ - default: none
140
+ - status: NOT currently supported
141
+
142
+ Location of the github repo where your site notes are located. By default, this is assumed to be your `workspaceRoot` if not set. This is used with the `Publish Notes` command
143
+
144
+ ### siteUrl
145
+ - required
146
+
147
+ Set to the URL that you plan on publishing to. All links will be prefixed with this.
148
+ If you are publishing with github pages, the format is `https://{username}.github.io/{repo}/`
149
+
150
+ ### usePrettyRefs (optional)
151
+
152
+ - default: True
153
+
154
+ Whether to use pretty note refs or plain refs.
155
+
156
+ ### writeStubs (optional)
157
+
158
+ - default: true
159
+
160
+ Whether to write [[stubs|dendron.concepts#stubs]] when publishing.
161
+
162
+ Writing a stub will create an empty note in your vault with the name of the stub.
163
+
164
+ Writing stubs is important to guarantee permanent urls as Dendron will randomize stub ids whenever Dendron restarts.
165
+
166
+ ### Github Options
167
+
168
+ #### gh_edit_link
169
+
170
+ - default: true
171
+ Show a edit on github link at the bottom of the page
172
+
173
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publish.edit-on-github.jpg)
174
+
175
+ #### gh_edit_repository
176
+
177
+ the URL of the project's GitHub repository
178
+
179
+ - NOTE: if you are using [[remote vaults|dendron.concepts#remote-vault]], this value will be ignored and the [[remote url|dendron.topic.config#remote]] will be used instead
180
+
181
+ #### gh_edit_branch
182
+
183
+ - default: master
184
+
185
+ the branch that the docs site is served from
186
+
187
+ #### gh_edit_view_mode
188
+
189
+ - default: tree (brings user to github page)
190
+
191
+ switch to "edit" to bring the user directly into editing mode
192
+
193
+ ### SEO Options
194
+
195
+ #### title
196
+
197
+ - title of page
198
+ - eg: `Dendron`
199
+
200
+ #### description
201
+
202
+ - eg: `Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you create, organize, and collaborate on knowledge bases of any size.`
203
+
204
+ #### author
205
+
206
+ Name of person or organization doing the publishing
207
+
208
+ - eg: `Kevin`
209
+
210
+ #### twitter
211
+
212
+ Twitter Handle
213
+
214
+ - eg: `dendronhq`
215
+
216
+ ## Hierarchy Configuration
217
+
218
+ You can update configuration on a per hierarchy level by modifying `site.config` like in the example below
219
+
220
+ ```yml
221
+ site:
222
+ config:
223
+ dendron:
224
+ publishByDefault: true
225
+ ...
226
+ ```
227
+
228
+ To set options for **all** hierarchies, set `{hiearchy name}` to **root**.
229
+
230
+ ### publishByDefault
231
+
232
+ - default: true
233
+ - values: true|false|hashByVault
234
+
235
+ If set to false, dendron will only publish notes within the hierarchy that have `published: true` set in the frontmatter
236
+
237
+ If set as a hash, you can further specify `publishByDefault` settings on a per vault basis. The key is the name of the vault and the value is a boolean.
238
+
239
+ For example, the following config says that the `finance` hiearchy in the `public` vault should all be published but that the `finance` hiearchy in the `private` vault should not
240
+
241
+ ```yml
242
+ site:
243
+ config:
244
+ finance:
245
+ publishByDefault:
246
+ public: true
247
+ private: false
248
+ ```
249
+
250
+ ### noindexByDefault
251
+
252
+ - default: false
253
+ - status: NOT currently supported
254
+
255
+ If set to true, dendron will add the following meta tag `<meta name="robots" content="noindex, nofollow”>` which will tell google to not index your page
256
+
257
+ When google indexes a page, it will penalize sites that have duplicate content from other sites. this is useful if you are using your hiearchy as a [[cache|dendron.workflows.cache]]
258
+
259
+ ### customFrontmatter
260
+
261
+ - default: \[]
262
+
263
+ If set, dendron will add the specified frontmatter to each published note in the hierarchy. note that this will override existing keys with the same name when publishing
264
+
265
+ - eg. add `toc: true` to all notes published under the `iam.*` hierarchy
266
+
267
+ ```yml
268
+ config:
269
+ iam:
270
+ customFrontmatter: [
271
+ {
272
+ key: "toc",
273
+ value: true,
274
+ }
275
+ ]
276
+ ```
277
+
278
+ ## Examples
279
+
280
+ ### Example publishing entire vault
281
+
282
+ - vault
283
+
284
+ ```
285
+ .
286
+ ├── root.md
287
+ ├── dendron.md
288
+ ├── dendron.quickstart.md
289
+ ├── dendron.zen.md
290
+ ├── flowers.md
291
+ └── flowers.bud.md
292
+ ```
293
+
294
+ - dendron.yml
295
+
296
+ ```yml
297
+ publish:
298
+ siteHierarchies: [root]
299
+ ```
300
+
301
+ - what gets published
302
+
303
+ ```
304
+ .
305
+ └── root.md
306
+ ├── dendron
307
+ │ ├── dendron.quickstart
308
+ │ └── dendron.zen
309
+ └── flowers
310
+ └── flowers.bud
311
+ ```
312
+
313
+ ### Example publishing just one domain
314
+
315
+ - vault
316
+
317
+ ```
318
+ .
319
+ ├── root.md
320
+ ├── dendron.md
321
+ ├── dendron.quickstart.md
322
+ └── dendron.zen.md
323
+ ```
324
+
325
+ - dendron.yml
326
+
327
+ ```yml
328
+ publish:
329
+ siteHierarchies: [dendron]
330
+ ```
331
+
332
+ - published:
333
+
334
+ ```
335
+ .
336
+ └── dendron
337
+ ├── dendron.quickstart
338
+ └── dendron.zen
339
+ ```
340
+
341
+ ### Examples of CNAME, Github and SEO Options
342
+
343
+ ```yml
344
+ site:
345
+ siteHierarchies:
346
+ - dendron
347
+ siteRootDir: docs
348
+ gh_edit_repository: "https://github.com/dendronhq/dendron-site"
349
+ logo: "vault/assets/images/logo.png"
350
+ siteUrl: "https://dendron.so"
351
+ githubCname: "dendron.so"
352
+ title: Dendron
353
+ author: "dendronhq"
354
+ twitter: "dendronhq"
355
+ description: "Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you create, organize, and collaborate on knowledge bases of any size."
356
+ vaults:
357
+ - fsPath: vault
358
+ ```
359
+
360
+ ## Note Configuration
361
+
362
+ You can specify how notes are published via the frontmatter of each note.
363
+
364
+ ### published
365
+
366
+ - default: true
367
+
368
+ To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
369
+
370
+ ```yml
371
+ ...
372
+ published: false
373
+ ```
374
+
375
+ ### nav_exclude
376
+
377
+ If set, do not include the current note in the navigation bar.
378
+
379
+ ### nav_order
380
+
381
+ - type: number
382
+
383
+ If set, denote order that item appears in the published nav bar
384
+
385
+ ### noindex
386
+
387
+ - default: false
388
+
389
+ To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
390
+
391
+ ```yml
392
+ ...
393
+ noindex: true
394
+ ```
395
+
396
+ ### collection options
397
+
398
+ #### has_collection
399
+
400
+ - default: false
401
+
402
+ Whether a given page is a collection. A collection doesn't have a table of contents and allows you to set collection specific options.
403
+
404
+ #### date
405
+
406
+ If set, used to designate a custom publication date. By default, use timestamp of `created` field.
407
+
408
+ #### skipLevels
409
+
410
+ If set, determines how many levels of children to skip when making the collection. For example, you might have the following hierarchy.
411
+
412
+ ```
413
+ - blog.md
414
+ - blog.reading.md
415
+ - blog.reading.journal.md
416
+ - blog.reading.journal.2020.md
417
+ - blog.reading.journal.2020.12.md
418
+ - blog.reading.journal.2020.12.20.one.md
419
+ - blog.reading.journal.2020.12.31.two.md
420
+ ```
421
+
422
+ When you publish, you might only want to show the leaf nodes and skip the intermediary levels. In the above example, setting `skipLevels: 3` on `blog.reading.md` will result in the following hierarchy being published.
423
+
424
+ ```
425
+ - blog.md
426
+ - blog.reading.md
427
+ - blog.reading.journal.2020.12.20.one.md
428
+ - blog.reading.journal.2020.12.31.two.md
429
+ ```
430
+
431
+ #### sort_order
432
+
433
+ - default: `ascending`
434
+ - values: `ascending|reverse`
435
+
436
+ Sort items in a collection page. Ascending by default. Specify `reverse` to sort in descending order.
437
+
438
+ ## Line Configuration
439
+
440
+ You can control publication on a per line basis.
441
+
442
+ ### LOCAL_ONLY_LINE
443
+
444
+ Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
445
+
446
+ ```markdown
447
+ Hello World! <!-- Will be published -->
448
+
449
+ This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
450
+ ```
451
+
452
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
453
+

Added: vault/dendron.topic.publishing.faq.md

vault/dendron.topic.publishing.faq.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 5a529992-0c62-4291-81df-550638f06a46
3
+ title: FAQ
4
+ desc: ''
5
+ updated: 1609951339287
6
+ created: 1609883599513
7
+ ---
8
+ ### Why am I taken to a 403 page?
9
+
10
+ Dendron will auto-generate 403 pages during publication when a published note links to notes that are not published. You can see [[here|dendron.topic.publishing.selective-publication]] for configuration behind selective publication.
11
+

Added: vault/dendron.topic.publishing.features.md

vault/dendron.topic.publishing.features.md ADDED
@@ -0,0 +1,80 @@
1
+ ---
2
+ id: 2fe96d3a-dcf9-409b-8a09-fdaa5a664433
3
+ title: Features
4
+ desc: ''
5
+ updated: 1614637638117
6
+ created: 1608528227846
7
+ nav_order: 1
8
+ ---
9
+
10
+ ### Nested Hierarchies
11
+
12
+ Publishing supports the same nested hierarchies as your notes and allows you to navigate via the sidebar.
13
+
14
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-hierarchy.gif" />
15
+
16
+ ### Nav Based Hierarchy Hints
17
+
18
+ You can see at a glance which notes have children and explore them from the nav without refreshing the page.
19
+
20
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron.jekyll.gif)
21
+
22
+ ### Edit on Github
23
+
24
+ Every page can accept one-click contributions as long as the contributor has a github account.
25
+
26
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll.edit.jpg)
27
+
28
+ Example of making a contribution to Dendron.
29
+
30
+ <a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
31
+
32
+ ### Lookup
33
+
34
+ If you'd rather not click, dendron-jekyll also supports path based lookup.
35
+
36
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-lookup.gif" />
37
+
38
+ ### Permanent Ids
39
+
40
+ Every page is published using its unique ID which means that urls will never change, even if the filenames do.
41
+
42
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-ids.jpg" />
43
+
44
+ If you have a free github account, then you can host your Dendron notes for free using [github pages](https://pages.github.com/)
45
+
46
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-domain.jpg" />
47
+
48
+ ### Jekyll Liquid Tags and Variables
49
+
50
+ You can find the docs on this under [[liquid|dendron.topic.liquid]]
51
+
52
+ - NOTE: this will only be "compiled" in the published site but won't be rendered in the regular markdown
53
+
54
+ <img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-liquid.gif" />
55
+
56
+ ### Selective Publication
57
+
58
+ You can choose to publish your whole vault, a single domain, or multiple domains within your vault.
59
+
60
+ ### Note References
61
+
62
+ Dendron has [[note references|dendron.topic.refs]] that let you inline either the whole note or parts of a note into another note. Publishing via Dendron will also publish note references as part of the process.
63
+
64
+ <a href="https://www.loom.com/share/8eb01f6c3196415c8aadc4992805a176"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/8eb01f6c3196415c8aadc4992805a176-with-play.gif"> </a>
65
+
66
+ ### Backlinks
67
+
68
+ This is the equivalent to the [[backlinks panel|dendron.topic.workbench#backlinks]] when using the desktop app.
69
+
70
+ Backlinks are automatically deduped and also work in a multi-vault setting.
71
+
72
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__8_08_PM.jpg)
73
+
74
+ <!-- ### Bad Links Report
75
+
76
+ When building your site by running `Dendron: Build Pod`, Dendron will generate a bad links report of all wiki-links that did not resolve. It will also update the links to point to a 404 page instead.
77
+
78
+ <a href="https://www.loom.com/share/91c4d7b023754b76b4d02519946603e0">
79
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/91c4d7b023754b76b4d02519946603e0-with-play.gif"> </a>
80
+ -->

Added: vault/dendron.topic.publishing.github.md

vault/dendron.topic.publishing.github.md ADDED
@@ -0,0 +1,118 @@
1
+ ---
2
+ id: 877f4347-f013-43ba-aec4-87412b2e1bec
3
+ title: Github
4
+ desc: ''
5
+ updated: 1610687706858
6
+ created: 1608770937168
7
+ ---
8
+ This guide describes publishing to github using github actions
9
+
10
+ ## Pre-requisite
11
+
12
+ - we assume that you already have your workspace under version control and a repository on github
13
+
14
+ ## Setup
15
+
16
+ 1. Checkout the pages branch and push it to github
17
+
18
+ ```bash
19
+ git checkout -b pages
20
+ git push origin pages
21
+ ```
22
+
23
+ 2. Switch back to your original branch
24
+
25
+ - NOTE: if you are using old versions of github, this command will be `git checkout master`
26
+
27
+ ```bash
28
+ git checkout main
29
+ ```
30
+
31
+ 3. Create a `package.json` at the root of your workspace
32
+
33
+ - NOTE: by default, we adopt the [Creative Commons License](https://creativecommons.org/licenses/by/4.0/legalcode) but you might want to change this depending on your use case
34
+
35
+ ```json
36
+ {
37
+ "scripts": {
38
+ "dendron-cli": "dendron-cli"
39
+ },
40
+ "license": "CC BY 4.0",
41
+ "devDependencies": {
42
+ "@dendronhq/dendron-11ty": "^1.24.4",
43
+ "@dendronhq/dendron-cli": "^0.24.0"
44
+ }
45
+ }
46
+ ```
47
+
48
+ 4. Create the workflow `.github/workflows/dendron-action.yml`:
49
+
50
+ ```yml
51
+ name: Dendron
52
+
53
+ on:
54
+ push:
55
+ branches:
56
+ - master
57
+
58
+ jobs:
59
+ build:
60
+ runs-on: ubuntu-latest
61
+ steps:
62
+ - name: Checkout source
63
+ uses: actions/checkout@v2
64
+
65
+ - name: Install npm dependencies
66
+ run: npm install
67
+
68
+ - name: Build pod
69
+ run: npm run dendron-cli -- buildSiteV2 --wsRoot . --stage prod
70
+
71
+ - name: Deploy site
72
+ uses: peaceiris/actions-gh-pages@v3
73
+ with:
74
+ github_token: ${{ secrets.GITHUB_TOKEN }}
75
+ publish_branch: pages
76
+ publish_dir: docs/
77
+ force_orphan: true
78
+ cname: "dendron.so"
79
+
80
+ ```
81
+
82
+ 5. Commit these changes and then push your main branch
83
+
84
+ ```bash
85
+ git add .
86
+ git commit -m "add publishing via gh-action"
87
+ git push
88
+ ```
89
+
90
+ 6. Update your github pages setting to build github pages from the `pages` branch and using the root folder.
91
+
92
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.pages.jpg)
93
+
94
+ 7. Github actions will update your page every time you push. You might have to add a change and push before your changes will show up. You can verify that your action is running by clicking on the actions tab in github.
95
+
96
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.actions.jpg)
97
+
98
+
99
+ <!--
100
+ 1. Run > Dendron: Doctor
101
+ 2. Select `Add Publishing Requirements`
102
+
103
+ This will initialize the following files into your dendron workspace
104
+
105
+ ```
106
+ # package.json
107
+ # .github
108
+ ## workflows
109
+ ### dendron-action.yml
110
+ ```
111
+
112
+ 3. By default, when you are ready for publishing, Dendron will
113
+ -->
114
+
115
+ ## Citations
116
+
117
+ - this guide is heavily inspired by [[the github action guide|dendron.guides.tips#publish-to-github-pages-with-actions]] originally published by [Luke Carrier](https://github.com/LukeCarrier)
118
+

Added: vault/dendron.topic.publishing.guides.md

vault/dendron.topic.publishing.guides.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: 1d9c4d11-1536-449b-af6b-a4a1acb203e4
3
+ title: Guides
4
+ desc: ''
5
+ updated: 1611351277601
6
+ created: 1611351130281
7
+ ---
8
+
9
+
10
+ ## Vercel
11
+
12
+ To publish with vercel, you can use [this repo](https://github.com/dendronhq/workspace-vercel-sample) as a template. Output of this template is [here](https://workspace-vercel-sample.vercel.app/)
13
+
14
+ 1. Fork the above repository
15
+ 2. Deploy in vercel with the following values
16
+ - build override
17
+ ```bash
18
+ npm run dendron-cli -- buildSiteV2 --wsRoot . --stage prod
19
+ ```
20
+ - output override: `docs`
21
+ 3. After deployment, update the `dendron.yml` `siteUrl` field to the url of your domain
22
+
23
+

Added: vault/dendron.topic.publishing.md

Files changed (1) hide show
  1. vault/dendron.topic.publishing.md +8 -0
vault/dendron.topic.publishing.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ id: 579e379b-3eca-4676-b51c-c66eb26a11b8
3
+ title: Publishing
4
+ desc: ''
5
+ updated: 1614547010717
6
+ created: 1613935381533
7
+ ---
8
+

Added: vault/dendron.topic.publishing.migration.md

vault/dendron.topic.publishing.migration.md ADDED
@@ -0,0 +1,69 @@
1
+ ---
2
+ id: fd26b3ef-7978-41c9-8f45-4c4f8414951d
3
+ title: Migration
4
+ desc: ''
5
+ updated: 1609529113068
6
+ created: 1608528487798
7
+ ---
8
+ All values that used to be written into `_config.yml` will now be moved into `dendron.yml`. You can see the currently supported configuration values here: `https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L71:L71`
9
+
10
+ If you currently have a Jekyll based Dendron page, note that the following settings have changed:
11
+
12
+ - the `url` property from `_config.yml` is now `siteUrl` in `dendron.yml`
13
+ - favicon is now controlled by `siteFaviconPath` in `dendron.yml` and is a path relative to your workspace root
14
+ - `CNAME` is now controlled by `githubCname` property in `dendron.yml`
15
+ - we are using [prismjs](https://prismjs.com/) to do syntax highlighting which means code block highlighting languages might appear under a different identifier. 11ty will throw an error if compiling a language without the right identifier
16
+ - you can see the list of all supported languages [here](https://prismjs.com/#supported-languages)
17
+ - dendron [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] will be set to true by default
18
+
19
+ ### Sample dendron.yml config
20
+
21
+ - publishing without a cname
22
+
23
+ ```yml
24
+ version: 1
25
+ vaults:
26
+ - fsPath: vault
27
+ site:
28
+ copyAssets: true
29
+ siteHierarchies:
30
+ - dendron
31
+ siteRootDir: docs
32
+ siteUrl: "kevinslin.github.io/dendron-11ty-test"
33
+ usePrettyRefs: true
34
+ ```
35
+
36
+ - using custom cname
37
+
38
+ ```yml
39
+ version: 1
40
+ vaults:
41
+ - fsPath: vault
42
+ site:
43
+ copyAssets: true
44
+ siteHierarchies:
45
+ - dendron
46
+ siteRootDir: docs
47
+ usePrettyRefs: true
48
+ siteUrl: "https://11ty.dendron.so"
49
+ githubCname: "11ty.dendron.so"
50
+ ```
51
+
52
+ ### Sample repo
53
+
54
+ - [github repo](https://github.com/kevinslin/dendron-11ty-test/deployments/activity_log?environment=github-pages)
55
+ - [github page](https://kevinslin.github.io/dendron-11ty-test/)
56
+
57
+ ## Gaps
58
+
59
+ 11ty publishing is currently not at full feature parity with Jekyll publishing. Notably, the following features are missing:
60
+
61
+ - ~~`edit on github` links~~
62
+ - ~~`jekyll-seo` functionality~~
63
+ - ~~math~~
64
+ - ~~anchor headers~~
65
+ - setting a custom color theme
66
+ - support for bad links report
67
+ - support for automatically generated toc
68
+ - integration with dendron plugin
69
+

Added: vault/dendron.topic.publishing.misc.md

vault/dendron.topic.publishing.misc.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: 491cafdd-d4bf-4c6a-9f95-532af4666828
3
+ title: Misc
4
+ desc: ''
5
+ updated: 1614630219483
6
+ created: 1614630136994
7
+ ---
8
+
9
+
10
+ ## Markdown Differences
11
+
12
+ There are a few differences between a published Dendron site and what you see using the preview. This document attempts to enumerate these difference.
13
+
14
+ ### Blockquote
15
+
16
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Markdown_-_Dendron.jpg)
17
+
18
+ ## Related
19
+ - [[Preview Your Site|dendron.topic.publishing.quickstart.preview-your-site]]

Added: vault/dendron.topic.publishing.navigation.md

vault/dendron.topic.publishing.navigation.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: 5f23182f-2936-4790-8d04-00bd502df723
3
+ title: Navigation
4
+ desc: ''
5
+ updated: 1609883540998
6
+ created: 1609563320271
7
+ ---
8
+ Dendron has two navigation sections: the nav bar on the left and the table of contents on the bottom of each note.
9
+
10
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.nav.jpg)
11
+
12
+ ## Sort Order
13
+
14
+ ## Navigation Side Bar
15
+
16
+ Nav order is controlled, in order of precedence, by the following:
17
+
18
+ - custom [[nav_order|dendron.topic.publishing.configuration#nav_order]] property in the frontmatter
19
+ - alphabetically by title
20
+
21
+ The navbar will first show all notes with the `nav_order` property before showing notes alphabetically. Notes with the [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] attribute will not be shown in the navbar
22
+
23
+ ## Table of Contents
24
+
25
+ The nav order for the table of contents that is generated at the bottom of each node works in the same way as the navigation side bar.
26
+
27
+ ## Nav Exclude
28
+
29
+ To exclude an item from navigation, you can set the [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] on the note frontmatter. This will exclude it from both the navigation side bar and the table of contents.
30
+

Added: vault/dendron.topic.publishing.quickstart.md

vault/dendron.topic.publishing.quickstart.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 861e4e48-dcc5-4813-a695-8940ba6e64d3
3
+ title: Quickstart
4
+ desc: ''
5
+ updated: 1614538864287
6
+ created: 1608528402469
7
+ nav_order: 2
8
+ ---
9
+
10
+ # Quickstart
11
+
12
+ NOTE: it's possible to publish Dendron on any platform that can host static sites. This guide covers publishing to [Github Pages](https://pages.github.com/)
13
+
14
+ This is divided into two parts
15
+ 1. Setting up your local workspace for publication
16
+ 2. Publishing

Added: vault/dendron.topic.publishing.quickstart.preview-your-site.md

vault/dendron.topic.publishing.quickstart.preview-your-site.md ADDED
@@ -0,0 +1,131 @@
1
+ ---
2
+ id: 1399b5d2-28fb-4077-aa5f-c8edbe52bc5d
3
+ title: Preview Your Site
4
+ desc: ''
5
+ updated: 1614965542494
6
+ created: 1610844309611
7
+ nav_order: 1
8
+ ---
9
+ ## VSCode
10
+
11
+ The following describes how to prepare your notes for publication using VSCode.
12
+
13
+ ### Pre-requisites
14
+
15
+ - node version 0.12 or higher, see installation guide [[here|dendron.guides.install-node]]
16
+
17
+ ### Preview your notes
18
+
19
+ 1. Navigate to a Dendron workspace. If you don't have one, you can create one by running `> Dendron: Initialize Workspace` and choosing `empty repository`
20
+ 2. Run `Site: Preview` to launch the site preview
21
+ - The first time you run this, you will need to install the required dependencies. Hit install to do so
22
+ ![Install dependencies](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.site-preview.jpg)
23
+ - when dependencies are done installing, Dendron will automatically open up a browser with a preview of your published notes (if this is the first time you've run this, VSCode will ask you for permission to open the link)
24
+ ![Dendron Site Preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.preview.jpg)
25
+
26
+ ### Add a note
27
+
28
+ 1. Right now or page is pretty sparse. Lets add some more notes
29
+
30
+ - first hit cancel on the site preview
31
+ ![Cancel preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.preview-cancel.jpg)
32
+ - add a `hello` note (see instructions for creating notes [[here|dendron.tutorial.notes#creating-your-first-note]])
33
+ - add `How do you do?` in the body so your note looks like the below (note that the id and times will be different)
34
+
35
+ ```md
36
+ ---
37
+ id: 7cefc5e1-2073-4327-86f0-a5319385a483
38
+ title: Hello
39
+ desc: ''
40
+ updated: 1610686311651
41
+ created: 1610686307785
42
+ ---
43
+
44
+ How do you do?
45
+ ```
46
+ 2. run `Site: Preview` again to see the results
47
+ ![Dendron site with new note](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.with-hello.jpg)
48
+ 3. click `hello` to navigate to your new note
49
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.with-hello.jpg)
50
+ 4. Alternatively, you can also use the search bar on the top to do a lookup of your note by path or title
51
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/0cf674234df34854a988176b189156b2" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
52
+
53
+ ### Get ready to publish
54
+
55
+ When you are ready, you can go to [[publishing your site|dendron.topic.publishing.quickstart.publishing-your-site]] for instructions on announcing your site to the world.
56
+
57
+ ## CLI
58
+
59
+ The following describes how to prepare your notes for publication using [[Dendron CLI|dendron.topic.cli]].
60
+
61
+ ### Requirements
62
+
63
+ - pre-requisitie:
64
+ - node version 0.12 or higher, see installation guide [[here Node|dendron.guides.install-node]]
65
+
66
+ ### Setup
67
+
68
+ In order to to use the 11ty based publishing, initialize your workspace with the following commands.
69
+
70
+ ```bash
71
+ npm init -y
72
+ npm install @dendronhq/dendron-cli@latest
73
+ npm install @dendronhq/dendron-11ty@latest
74
+ ```
75
+
76
+ ### Local Preview
77
+
78
+ After you have your dependencies installed, build your your site using the following command.
79
+
80
+ ```bash
81
+ npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve
82
+ ```
83
+
84
+ This will both compile your site locally and make it available at `localhost:8080` for instant preview. When building your site locally, the pages will be build to `{wsRoot}/build/site`.
85
+
86
+ <!--
87
+ ### Adding metadata
88
+
89
+ Currently, your site is rather spare. You can add metadata to your site. Open the config by going to `Dendron: Configure (yaml)`. This should take you to the following configuration file
90
+
91
+ ```yaml
92
+ version: 1
93
+ vaults:
94
+ -
95
+ fsPath: vault
96
+ site:
97
+ copyAssets: true
98
+ siteHierarchies:
99
+ - root
100
+ siteRootDir: docs
101
+ usePrettyRefs: true
102
+ ```
103
+
104
+ Try adding some of the following properties underneath site
105
+ - replace `{YOUR NAME}` with your actual name
106
+
107
+ ```yml
108
+ ...
109
+ site:
110
+ ...
111
+ title: {YOUR NAME} Digital Garden
112
+ description: This is {YOUR NAME} piece of the internet
113
+ author: `{YOUR NAME}`
114
+ ```
115
+
116
+ When your done, run the pre
117
+
118
+ -->
119
+
120
+ ### Build for deployment
121
+
122
+ When you are ready to publish to github, make sure to change the stage to `prod`.
123
+
124
+ ```bash
125
+ npx dendron-cli buildSiteV2 --wsRoot . --stage prod
126
+ ```
127
+
128
+ This will build your site to the path specified by [[siteRootDir|dendron.topic.publishing.configuration#siterootdir-required]] in `dendron.yml`. By default, this is located at `{wsRoot}/docs`.
129
+
130
+ ![[dendron.topic.publishing.quickstart.preview-your-site#get-ready-to-publish,1:#*]]
131
+

Added: vault/dendron.topic.publishing.quickstart.publishing-your-site.md

vault/dendron.topic.publishing.quickstart.publishing-your-site.md ADDED
@@ -0,0 +1,106 @@
1
+ ---
2
+ id: 230d0ccf-5758-4a8f-b39b-3b68e1482e2b
3
+ title: Publishing Your Site
4
+ desc: ''
5
+ updated: 1614113190758
6
+ created: 1610844337503
7
+ ---
8
+
9
+ ## VSCode
10
+
11
+ ### Pre-requisites
12
+ - This assumes you have a github repository.
13
+ - If not, you can create one [here](https://github.com/new) from your existing workspace
14
+
15
+ ### Create a github repo
16
+ - Follow the instructions [here](https://pages.github.com/) to create a repository named `{username}.github.io` where `{username}` is your username on Github
17
+
18
+ ### Add your notes
19
+ Follow the instructions to push to an existing repository
20
+
21
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github.jpg)
22
+
23
+ ### Turn on github pages
24
+
25
+ Go to settings
26
+
27
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-settings.jpg)
28
+
29
+ Go down to github pages and select the main branch
30
+
31
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-pages.jpg)
32
+
33
+ Select the docs folder and click save.
34
+
35
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-docs.jpg)
36
+
37
+ ### Configure your notes for publication
38
+
39
+ In order for to build your notes for publication, you'll have to tweak a few settings first. Open the command prompt and type `>Dendron: Configure (yaml)`
40
+
41
+ You should see something like the following
42
+
43
+ ```yml
44
+ version: 1
45
+ vaults:
46
+ -
47
+ fsPath: vault
48
+ site:
49
+ copyAssets: true
50
+ siteHierarchies:
51
+ - root
52
+ siteRootDir: docs
53
+ usePrettyRefs: true
54
+ title: Dendron
55
+ ```
56
+
57
+ Make the following modification under `site:
58
+
59
+ ```yml
60
+ ...
61
+ site:
62
+ ...
63
+ siteUrl: {SITE_URL}
64
+ ```
65
+
66
+ - NOTE: you can get your SITE_URL from the settings page in github. you want to take everything up to `.com` (eg. if the url shown is `https://kevinslin.github.io/dendron-publish-sample/`, then the site url would be ` https://kevinslin.github.io`)
67
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-url.jpg)
68
+ - NOTE2: if you've setup your github repository using `{username}.github.io` format, your site url will be the same as the url shown
69
+ - otherwise (as in the example abov)e, you will have a suffix at the end of your SITE_URL (eg. `dendron-publish-sample`)
70
+ - in this case, you will need to add the suffix using the `assetsPrefix` property
71
+
72
+ #### Examples
73
+ - publishing the repo `kevinslin.github.io`
74
+
75
+ ```yml
76
+ site:
77
+ siteUrl: https://kevinslin.github.io
78
+ ```
79
+
80
+ - publishing the repo `dendron-sample`
81
+
82
+ ```yml
83
+ site:
84
+ assetsPrefix: dendron-sample
85
+ siteUrl: https://kevinslin.github.io
86
+ ```
87
+
88
+ ### Build your notes for publication
89
+
90
+ In order to have Dendron generate your website, you use the `> Site: Build` command.
91
+
92
+ ### Publish your notes
93
+
94
+ Github will publish your notes everytime you push. Commit all your changes and perform a git push
95
+
96
+ ```bash
97
+ git add .
98
+ git commit -m "first dendron page"
99
+ git push
100
+ ```
101
+
102
+ When you are done, you should see a page like the one [here](https://kevinslin.github.io/dendron-publish-sample/)
103
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.den-wel.jpg)
104
+
105
+
106
+ ### Congratulations, you just published your first note 🌱

Added: vault/dendron.topic.publishing.selective-publication.md

vault/dendron.topic.publishing.selective-publication.md ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ id: c93938a4-0938-49d0-aca2-00e624793650
3
+ title: Selective Publication
4
+ desc: ''
5
+ updated: 1613873980711
6
+ created: 1609883716869
7
+ ---
8
+ In Dendron, you control what gets published.
9
+
10
+ ![[dendron.topic.publishing.configuration#summary,1:#*]]
11
+
12
+ ## Globally
13
+
14
+ ![[dendron.topic.publishing.configuration#sitehierarchies-required:#*]]
15
+
16
+ ## Per Hierarchy
17
+
18
+ ![[dendron.topic.publishing.configuration#hierarchy-configuration:#noindexByDefault]]
19
+
20
+ ## Per Note
21
+
22
+ ![[dendron.topic.publishing.configuration#note-configuration:#nav_exclude]]
23
+
24
+ ## 403 Page
25
+
26
+ If you link to a page that is not published, Dendron will show users a 403 page with the following content
27
+
28
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.403.jpg)
29
+

Added: vault/dendron.topic.publishing.troubleshooting.md

vault/dendron.topic.publishing.troubleshooting.md ADDED
@@ -0,0 +1,60 @@
1
+ ---
2
+ id: 5ca2fe99-0abc-413d-aa06-50f9a66e13e0
3
+ title: Troubleshooting
4
+ desc: ''
5
+ updated: 1612282296770
6
+ created: 1609525003662
7
+ ---
8
+ ### Site Preview shows "Cannot Get/"
9
+
10
+ Causes:
11
+
12
+ 1. You have another program running on port 8080
13
+ 2. You have a firewall that is blocking port 8080
14
+
15
+ Diagnosis:
16
+
17
+ 1. Check if something is running on port 8080 and close it
18
+ 2. Check if your firewall is blocking port 8080
19
+ - [windows](https://windowsreport.com/is-windows-firewall-blocking-port-program/)
20
+
21
+ ### My favicon isn't showing up
22
+
23
+ This might be due to favicon caching on localhost. It should resolve when published.
24
+
25
+ ### Search isn't working on the site
26
+
27
+ This could be the result of a CORS issue. Make sure that both `siteUrl` and `cname` are referring to the same domain.
28
+
29
+ This is good
30
+
31
+ ```
32
+ siteUrl: https://foo.com
33
+ cname: foo.com
34
+ ```
35
+
36
+ This is bad
37
+
38
+ ```
39
+ siteUrl: https://www.foo.com
40
+ cname: foo.com
41
+ ```
42
+
43
+ ### My image isn't showing up
44
+
45
+ - Make sure your images have a leading `/`. So `/assets/images/foo.jpg` instead of `assets/images/foo.jpg`.
46
+ - If you are publishing to github, check if [[assetsPrefix|dendron.topic.publishing.configuration#assetsprefix-optional]] is set
47
+
48
+ ### Command failed when installing or upgrading dependencies
49
+
50
+ ```bash
51
+ Command failed with ENOENT: npm install
52
+ ```
53
+
54
+ This could be due to multiple reasons:
55
+
56
+ ```
57
+ - Make sure the default shell you have for VSCode is set to a shell that has npm in it. See [here](https://stackoverflow.com/questions/37823194/cannot-find-runtime-node-on-path-visual-studio-code-and-node-js) for changing your default shell.
58
+ - Make sure that `package.json` is not open during installation (you might see `operation not permitted` on windows)
59
+ ```
60
+

Added: vault/dendron.topic.refs.md

Files changed (1) hide show
  1. vault/dendron.topic.refs.md +114 -0
vault/dendron.topic.refs.md ADDED
@@ -0,0 +1,114 @@
1
+ ---
2
+ id: f1af56bb-db27-47ae-8406-61a98de6c78c
3
+ title: References
4
+ desc: ''
5
+ updated: 1614057759268
6
+ created: 1597356582509
7
+ stub: false
8
+ ---
9
+ Dendron allows you to reference content from other notes and embed them in your current note.
10
+
11
+ Currently, Dendron supports 3 types of references:
12
+
13
+ - note references
14
+ - block references
15
+ - block range references
16
+
17
+ References have the following syntax
18
+
19
+ ```
20
+ ![[ NAME_OF_NOTE
21
+ #STARTING_HEADER # optional
22
+ :#ENDING_HEADER # optional
23
+ ]]
24
+ ```
25
+
26
+ - NOTE: Dendron recently switched the note ref syntax for `((ref: [[foo]]))` to `![[foo]]`. The videos have not yet been updated to reflect this change
27
+
28
+ ## Configuration
29
+
30
+ - note references by default come with an outline. They are called [[pretty refs|dendron.ref.terms#pretty-ref]].
31
+
32
+
33
+ Toggle the following configuration to turn off this setting.
34
+
35
+ ![[dendron.topic.config#useprettyrefs:#*]]
36
+
37
+ ## Commands
38
+
39
+ You can create a ref either by hand or using the `Copy Note Ref` command.
40
+
41
+ ![[dendron.topic.commands#copy-note-ref:#*]]
42
+
43
+ ## Note Reference
44
+
45
+ A note reference will include the entire contents of a note within another note. Below is an example of a note reference.
46
+
47
+ ```
48
+ ![[dendron.demo.refs.sample]]
49
+ ```
50
+
51
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.block.gif)
52
+
53
+ Note that references also respect the wildcard operator. The following example will include all child pages of sample.
54
+
55
+ ```
56
+ ![[dendron.demo.refs.sample.*]]
57
+ ```
58
+
59
+ ## Block Reference
60
+
61
+ A block reference will include the entire contents of a note starting from a specified heading.
62
+
63
+ ```
64
+ ![[demo.embed.block#head1]]
65
+ ```
66
+
67
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block.gif)
68
+
69
+ ## Block Range Reference
70
+
71
+ A block range reference will include the contents of a note starting from a `start` header and ending at a `end` header.
72
+
73
+ ```
74
+ ![[demo.embed.block#head1:#head3]]
75
+ ```
76
+
77
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block-range.gif)
78
+
79
+ ## Note Reference Offset
80
+
81
+ A note reference offset is a way to skip a number of lines when using a note reference. The syntax is `,{number}`. Below is an example of using a note reference offset to offset an initial heading, skipping the actual header when doing the embeding.
82
+
83
+ - NOTE: currently, note reference offsets are limited to the first anchor inside a block reference. They must also be a positive value
84
+
85
+ ```
86
+ ![[demo.embed.block#head1,1]]
87
+ ```
88
+
89
+ <a href="https://www.loom.com/share/31cb62916586453f8475f94ba68b74a1"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/31cb62916586453f8475f94ba68b74a1-with-play.gif"> </a>
90
+
91
+ ## Wildcard Header Reference
92
+
93
+ When you're referencing a header by reference, sometimes you don't care what the next header is, just that the reference covers all text up to the next header. You can now specify this using the `*` symbol in a header reference.
94
+
95
+ For example, the following would reference the content from header1 to the next header.
96
+
97
+ ```
98
+ ![[demo.embed.block#head1:#*]]
99
+ ```
100
+
101
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.wildcard.gif)
102
+
103
+ ## Recursive Reference
104
+
105
+ Note references can refer to notes with references inside. Dendron current supports references two levels deep. This applies to both the **local preview** as well as **publishing**.
106
+
107
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.recursion.jpg)
108
+
109
+ ## Wildcard Note Refs
110
+
111
+ [[Note references|dendron.topic.refs]] accept the `*` operator at the end which lets you grab all notes of a given level of hierarchy. This also works with typical note reference operation like block selection which means you can use it to grab specific blocks from every note in a level.
112
+
113
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/9401e5dfe60f4f589e14d50e280d11f5" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
114
+

Added: vault/dendron.topic.schema.md

Files changed (1) hide show
  1. vault/dendron.topic.schema.md +262 -0
vault/dendron.topic.schema.md ADDED
@@ -0,0 +1,262 @@
1
+ ---
2
+ id: c5e5adde-5459-409b-b34d-a0d75cbb1052
3
+ title: Schemas
4
+ desc: ''
5
+ updated: 1608530445742
6
+ created: 1595952505039
7
+ stub: false
8
+ ---
9
+ As you end up creating more notes, it can be hard to keep track of it all. This is why Dendron has **schemas** to help you manage your notes at scale. Think of schemas as an **optional type system** for your notes. They describe the hierarchy of your data and are themselves, represented as a hierarchy.
10
+
11
+ Schemas show up as icons next to lookup results.
12
+
13
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.intro.gif)
14
+
15
+ ## Why Use Schemas
16
+
17
+ Schemas help you categorize your notes by making sure your hierarchies are consistent with one another.
18
+
19
+ For example, lets say you have a bunch of projects and you know you like to keep your projects in the following hierarchy
20
+
21
+ ```
22
+ .
23
+ └── project
24
+ ├── retrospective
25
+ ├── people
26
+ ├── todo
27
+ └── meet
28
+ ```
29
+
30
+ Schemas will autosuggest valid children when you create a new project.
31
+
32
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.suggest.gif)
33
+
34
+ If you accidentally do a typo, your schema will let you know that you have an inconsistency.
35
+
36
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.unknown.gif)
37
+
38
+ ## Schema Anatomy
39
+
40
+ A schema is a YAML file with the following naming scheme `{name}.schema.yml`
41
+
42
+ Below is an example of a four-level hierarchy describing cli commands. The `id` field of the schema is used to build a [glob pattern](https://facelessuser.github.io/wcmatch/glob/) which will be used to match notes matching the schema.
43
+
44
+ ```yml
45
+ version: 1
46
+ schemas:
47
+ # this will match "cli.*" notes
48
+ - id: cli
49
+ # human readable description of hierarchy
50
+ desc: command line interface reference
51
+ # add this to the domain of your schema hierarchy
52
+ parent: root
53
+ # when a schema is a namespace, it can have arbitrary children. equivalent to cli.* glob pattern
54
+ namespace: true
55
+ children:
56
+ - cmd
57
+ - env
58
+ # will match cli.*.env
59
+ - id: env
60
+ desc: cli specific env variables
61
+ # will match cli.*.cmd.*
62
+ - id: cmd
63
+ desc: subcommands
64
+ namespace: true
65
+ ```
66
+
67
+ Below is another way of representing the above schema
68
+
69
+ ```
70
+ .
71
+ └── cli # matches cli
72
+ └── {cli child} # matches cli.*
73
+ ├── env # matches cli.*.env
74
+ └── cmd # matches cli.*.cmd
75
+ └── {cmd child} # matches cli.*.cmd.*
76
+ ```
77
+
78
+ ## Schema Properties
79
+
80
+ ### version (optional): number
81
+
82
+ - values: `0|1`
83
+ - default: 0
84
+ - description: schema version number
85
+
86
+ ### imports (optional): str\[]
87
+
88
+ - values: list of schemas to import
89
+ - default: \[]
90
+ - description: import schemas from another schema into the current schema
91
+ - when using schemas from an external schema file, you will need to prefix the schema with the file name without the `schema.yml` suffix
92
+ - NOTE: `import` is only available in schema version `1`
93
+
94
+ Example:
95
+
96
+ - foo.schema. yml
97
+
98
+ ```yml
99
+ version: 1
100
+ imports:
101
+ - bar
102
+ schemas:
103
+ - id: foo
104
+ parent: root
105
+ children:
106
+ - bar.bar # notice that we prefix the id bar with the filename
107
+ ```
108
+
109
+ - bar.schema.yml
110
+
111
+ ```yml
112
+ version: 1
113
+ schemas:
114
+ - id: bar
115
+ parent: root
116
+ children:
117
+ - one
118
+ - id: one
119
+ ```
120
+
121
+ The above would match the following files
122
+
123
+ ```
124
+ foo.bar # match
125
+ foo.bar.one #match
126
+ ```
127
+
128
+ ### schemas
129
+
130
+ - list of schema entities
131
+
132
+ #### id
133
+
134
+ the identifier of the schema. also designates the glob pattern match. this is the **only** required part of a schema. all other fields are optional
135
+
136
+ #### desc
137
+
138
+ human readable description of the schema node. these will automatically when creating notes that match the schema.
139
+
140
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-desc.gif)
141
+
142
+ #### parent
143
+
144
+ - only required for schema [domain](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#domain)
145
+ - NOTE: at least one schema MUST have `parent: root` set
146
+
147
+ #### namespace
148
+
149
+ making a schema node a namespace automatically brings its immediate children as part of the schema, even if they are not explicitly defined in the schema definition. it will also automatically set the pattern to `{namespace}.*`
150
+
151
+ - example:
152
+
153
+ ```yml
154
+ schemas:
155
+ - id: project
156
+ parent: root
157
+ namespace: true
158
+ ```
159
+
160
+ - this will match:
161
+ - `project`
162
+ - `project.foo`
163
+ - `project.bar`
164
+ - it will not match
165
+ - `project.foo.bar`
166
+
167
+ #### pattern
168
+
169
+ glob pattern that schema matches. by default, this is the `id` of the schema. you can override this.
170
+
171
+ For example, take a look at the journal schema below
172
+
173
+ ```yml
174
+ schemas:
175
+ - id: journal
176
+ title: journal
177
+ desc: ""
178
+ parent: root
179
+ children:
180
+ - year
181
+ - id: year
182
+ title: year
183
+ pattern: "[0-2][0-9][0-9][0-9]"
184
+ children:
185
+ - month
186
+ - id: month
187
+ title: month
188
+ pattern: "[0-9][0-9]"
189
+ children:
190
+ - day
191
+ - id: day
192
+ title: day
193
+ pattern: "[0-9][0-9]"
194
+ namespace: true
195
+ ```
196
+
197
+ This will match the following queries
198
+
199
+ ```
200
+ # journal
201
+ # journal.2020
202
+ # journal.2020.09
203
+ # journal.2020.09.12
204
+ # journal.2020.09.12.foo.md
205
+ ```
206
+
207
+ #### children
208
+
209
+ list of ids of schemas that are the child of the current schema
210
+
211
+ #### template
212
+
213
+ a template you can apply to all notes that match this schema. See **Schema Templates** for more details.
214
+
215
+ ```yml
216
+ template:
217
+ # identifier for the template (for a note based template, it would be the name of the note)
218
+ id: journal.template.daily
219
+ # what sort of template we are creating. currently, only 'note' is supported
220
+ type: note
221
+
222
+ ```
223
+
224
+ ## Schema Templates
225
+
226
+ Schema templates let you designate a note as a **template**. Newly created notes that match a schema with a template will have both the contents and custom frontmatter of the template note applied at creation.
227
+
228
+ This is extremely useful whenever you want to re-use the outline of a note. Examples include daily journals, weekly shopping lists, and weekly reviews.
229
+
230
+ <a href="https://www.loom.com/share/481b7ab051394c1caa383383bd265755">
231
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/481b7ab051394c1caa383383bd265755-with-play.gif">
232
+ </a>
233
+
234
+ ## Unknown Schema
235
+
236
+ Dendron doesn't force you to use schemas if you don't want to. This is why you can create notes that don't match any schema. Dendron will show you a `?` next to these results.
237
+
238
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-question.jpg)
239
+
240
+ > Sometimes ~~rules~~ schemas are meant to be broken
241
+
242
+ ## Working with Schemas
243
+
244
+ Schemas can be modified, created and deleted using the same lookup interface that you use for regular notes. See [[lookup|dendron.topic.lookup]] for further details about working with schemas.
245
+
246
+ ## Example Schemas
247
+
248
+ - [Project and Journal](https://gist.github.com/kevinslin/5ca7a6f25a239add5ea374f329e6a19e)
249
+
250
+ ## Troubleshooting
251
+
252
+ ### Error with parsing some schemas during initialization
253
+
254
+ If you get this error, it means that Dendron encountered some malformed schemas during initialization. You can open the error message to see what schemas are affected.
255
+
256
+ Common errors:
257
+
258
+ - the YAML isn't valid (use <http://www.yamllint.com/> to validate)
259
+ - there is no schema with `parent: root` property
260
+
261
+ ((ref:[[dendron.topic.schema]]#parent:#*))
262
+

Added: vault/dendron.topic.search.md

Files changed (1) hide show
  1. vault/dendron.topic.search.md +11 -0
vault/dendron.topic.search.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 09692c77-1861-4b01-a7e7-d0da8a80cea6
3
+ title: Search
4
+ desc: ''
5
+ updated: 1605970220353
6
+ created: 1605970055259
7
+ ---
8
+ Dendron gives you the ability to do a full text search of your notes. Most queries can be satisfied using [[lookup|dendron.topic.lookup]] but depending on the use case, sometimes searching is more useful.
9
+
10
+ We leverage VSCode [builtin search](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) capabilities to do full text search.
11
+

Added: vault/dendron.topic.seed-bank.md

Files changed (1) hide show
  1. vault/dendron.topic.seed-bank.md +28 -0
vault/dendron.topic.seed-bank.md ADDED
@@ -0,0 +1,28 @@
1
+ ---
2
+ id: 6ff8cbb6-e4b8-449b-a967-277b76e4ecef
3
+ title: Seed Bank
4
+ desc: ''
5
+ updated: 1607637413584
6
+ created: 1607621369889
7
+ nav_exclude: true
8
+ ---
9
+ The Dendron Seed Bank is a registry of public vaults that you can add to your workspace. At this time, we are launching with two vaults in the seed bank:
10
+
11
+ - dendron-site: this mirrors the content from <http://dendron.so/>
12
+ - aws: this mirrors the content from <http://aws.dendron.so/>
13
+
14
+ The vision for the seed bank is to create a repository of open source vaults that provide both notes and schemas for all the things that people care about.
15
+
16
+ ## Requesting a Vault
17
+
18
+ We are planning on adding many more vaults to this registry over time. To help us prioritize, we've
19
+ created the [Seed Request Template](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=seed-request.md&title=) on GitHub so you can request new subjects you want to see in the seed bank.
20
+
21
+ ## Submitting a Vault
22
+
23
+ If you have a vault that you think would make a good addition to the seed bank, you can submit a vault by following the instructions below:
24
+
25
+ 1. make sure your vault is pushed to a public git registry like github
26
+ 2. make sure that your vault has a public `README.md` and `LICENSE.md` inside the vault
27
+ 3. ping kevin on Discord or by email at [kevin@dendron.so](mailto:kevin@dendron.so) :)
28
+

Added: vault/dendron.topic.seeds.md

Files changed (1) hide show
  1. vault/dendron.topic.seeds.md +118 -0
vault/dendron.topic.seeds.md ADDED
@@ -0,0 +1,118 @@
1
+ ---
2
+ id: 4fdf54ac-599e-42e7-90a5-38964913a9a7
3
+ title: "Seeds \U0001F6A7"
4
+ desc: ''
5
+ updated: 1614965542492
6
+ created: 1600219243498
7
+ ---
8
+ > Note: Seeds are highly experimental and under active development. Content here is subject to change.
9
+
10
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/seeds.png)
11
+
12
+ Seeds represent existing knowledge out in the world. A seed could be a wikipedia article, a github repo, or an arbitrary website.
13
+
14
+ You can use a **Dendron Seed** to ingest data from existing sources and import them into your vault. Data ingestion is also referred to as **planting**.
15
+
16
+ Note that seeds differ from [[pods|dendron.topic.pod]] in that they help you ingest content from external sources from content that you might have no control over. Pods help you import/export your content between various platforms.
17
+
18
+ You can see an example of a published seeded vault [here](https://aws.dendron.so/).
19
+
20
+ # Using a seed
21
+
22
+ - NOTE: currently, seeds are only available using the [[dendron-cli|dendron.topic.cli]]
23
+
24
+ ## Pre-requisites
25
+
26
+ Make sure you have the dendron-cli installed.
27
+
28
+ ((ref:[[dendron.topic.cli]]#installation,1:#*))
29
+
30
+ ## Instructions
31
+
32
+ 1. Inside the workspace where you to plant your seeds, initialize a node project.
33
+ ```bash
34
+ cd /path/to/ws
35
+ yarn init
36
+ ```
37
+ 2. Install seeds that you want to plant
38
+ - currently, the only available seed is @dendronhq/og-aws-seed
39
+ - this seed gets data from [og-aws guide](https://github.com/open-guides/og-aws)
40
+ ```bash
41
+ yarn add @dendronhq/og-aws-seed
42
+ ```
43
+ 3. Plant seeds using the cli
44
+ ```
45
+ dendron-cli plantSeed --id @dendronhq/og-aws-seed --wsRoot ./ --vault ./vault
46
+ ```
47
+ 4. Enjoy your garden
48
+
49
+ # Creating a Seed
50
+
51
+ A seed is just a npm package. You can create your own by creating an npm package..
52
+
53
+ You can see an example of a custom seed [here](https://github.com/dendronhq/seeds.aws/tree/master/packages/og-aws-seed).
54
+
55
+ ## Instructions
56
+
57
+ 1. Initialize a new node project
58
+ ```bash
59
+ mkdir my-new-seed
60
+ cd my-new-seed
61
+ yarn init
62
+ ```
63
+ 2. Add core dependencies
64
+ ```bash
65
+ yarn add @dendronhq/seeds-core
66
+ ```
67
+ 3. Create a seed
68
+
69
+ ### Creating a seed
70
+
71
+ - index.ts
72
+
73
+ ```ts
74
+ import {
75
+ DendronSeed,
76
+ PrepareOpts,
77
+ SeedConfig,
78
+ Asset,
79
+ } from "@dendronhq/seeds-core";
80
+
81
+ export default class MySeed extends DendronSeed {
82
+
83
+ config() {
84
+ return {
85
+ src: {
86
+ type: "git" as const,
87
+ url: "https://github.com/{PATH_TO_REPO}.git",
88
+ },
89
+ mergeStrategy: "replace" as const,
90
+ source: {
91
+ name: "{NAME_OF_PROJECT}",
92
+ url: "{CITATION_URL}",
93
+ license: "{LICENSE}",
94
+ },
95
+ };
96
+ }
97
+
98
+ prepare(opts: PrepareOpts): Promise<{notes: Note[], assets: Asset[]}> {
99
+ //const srcFile = fs.readFileSync(path.join(root, 'README.md'), { encoding: "utf8" });
100
+ const { root: repoPath } = opts;
101
+ let notes: Note[] = [];
102
+ // your custom conversion logic
103
+ // ...
104
+ return notes
105
+ }
106
+ }
107
+ ```
108
+
109
+ ### Importing your seed
110
+
111
+ ```
112
+ dendron-cli plantSeed --id myseed --wsRoot /path/to/root --vault /path/to/vault
113
+ ```
114
+
115
+ # Resources
116
+
117
+ - [[Seeds API|dendron.dev.api.seeds]]
118
+

Added: vault/dendron.topic.snippets.md

Files changed (1) hide show
  1. vault/dendron.topic.snippets.md +70 -0
vault/dendron.topic.snippets.md ADDED
@@ -0,0 +1,70 @@
1
+ ---
2
+ id: 9eca1992-7540-4d9d-97fb-328b27748b2c
3
+ title: Snippets
4
+ desc: ''
5
+ updated: 1596561207607
6
+ created: 1596561207607
7
+ stub: false
8
+ ---
9
+ Snippets are templates that you can trigger to automatically insert text that you use on a regular basis. Examples include meeting note templates, contact details and recipes.
10
+
11
+ You can read about how to work with snippets [here](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
12
+
13
+ Dendron automatically comes with snippets. They are available at in the following file: `vault/.vscode/dendron.code-snippets`. You can see a copy of it [here](https://github.com/dendronhq/dendron-template/blob/master/vault/.vscode/dendron.code-snippets).
14
+
15
+ You can modify snippets by using `> Preferences: Configure User Snippets` and selection `dendron.code-snippets`.
16
+
17
+ ## Using Snippets
18
+
19
+ You can use [[intellisense|dendron.ref.intellisense]] to preview snippets and use `tab` key to complete them.
20
+
21
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tab-autocomplete.gif)
22
+
23
+ ((ref:[[dendron.pro.dendron-snippet-maker]]))
24
+
25
+ ## Default Snippets
26
+
27
+ Dendron comes with a series of default snippets when you first initialize your workspace. They are located in `{workspace}/vault/.vscode/dendron.code-snippets`.
28
+
29
+ ```ts
30
+ {
31
+ todo: {
32
+ prefix: "to",
33
+ scope: "markdown",
34
+ body: "- [ ]",
35
+ description: "render todo box",
36
+ },
37
+ tag: {
38
+ prefix: "#",
39
+ scope: "markdown,yaml",
40
+ body: "[[#${1:my-tag}|tag.${1}]]",
41
+ description: "tag",
42
+ },
43
+ date: {
44
+ prefix: "date",
45
+ scope: "markdown,yaml",
46
+ body: "$CURRENT_YEAR.$CURRENT_MONTH.$CURRENT_DATE",
47
+ description: "today's date",
48
+ },
49
+ time: {
50
+ prefix: "time",
51
+ scope: "markdown,yaml",
52
+ body: "$CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE",
53
+ description: "time",
54
+ }
55
+ }
56
+ ```
57
+
58
+ ## Issues
59
+
60
+ ### Can't autocomplete snippets inline
61
+
62
+ To get snippets to autocomplete, make sure you don't have snippets disabled
63
+
64
+ 1. go to > workspace: open user settings (json)
65
+ 2. change the following line to `true`
66
+
67
+ ```
68
+ "editor.suggest.showSnippets": false,
69
+ ```
70
+

Added: vault/dendron.topic.special-notes.md

Files changed (1) hide show
  1. vault/dendron.topic.special-notes.md +101 -0
vault/dendron.topic.special-notes.md ADDED
@@ -0,0 +1,101 @@
1
+ ---
2
+ id: 5c213aa6-e4ba-49e8-85c5-1bdcb33ce202
3
+ title: Special Notes
4
+ desc: ''
5
+ updated: 1610401212952
6
+ created: 1595004457029
7
+ stub: false
8
+ ---
9
+ Dendron has builtin support for a variety of special note formats. These notes can be created using regular lookup - these commands provide convenient shortcuts for frequently used notes.
10
+
11
+ ## Daily Journal
12
+
13
+ The daily journal helps you keep a journal for each day of the year. By default, it will create the journal under `daily.{date}` though this is configurable by setting the `dendron.dailyJournalDomain`.
14
+
15
+ You can create a daily journal using `> Dendron: Create Daily Journal Note` or `Cmd+Shift+I` shortcut.
16
+
17
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
18
+
19
+ ## Journal Note
20
+
21
+ A journal note is a self contained note that is meant to track something over time. Examples of journals include recording **workout sessions**, making **meeting notes**, and keeping a **mood journal**.
22
+
23
+ To create a journal note, trigger a lookup and then click on the calendar icon.
24
+
25
+ <a href="https://www.loom.com/share/3c3ddc1dc63547cea8bf186bec31f71b">
26
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/3c3ddc1dc63547cea8bf186bec31f71b-with-play.gif"> </a>
27
+
28
+ By default, Dendron will create the journal note with the following hierarchy `{domain}.journal.{y.MM.dd}`. `{domain}` is the **domain** of the current active note when you execute `New Journal Note`.
29
+
30
+ A reference for date formatting tokens can be found [here](https://moment.github.io/luxon/docs/manual/formatting.html)
31
+
32
+ ## Scratch Note
33
+
34
+ A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{y.MM.dd.HHmmss}`.
35
+
36
+ <a href="https://www.loom.com/share/2fd3042119124df8bb4592d8ffe6d708">
37
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/2fd3042119124df8bb4592d8ffe6d708-with-play.gif"> </a>
38
+
39
+ ## Configuration
40
+
41
+ All special notes support the following configuration options
42
+
43
+ - NodeType has the value of `Journal` or `Scratch`
44
+
45
+ ### default{NodeType}Name
46
+
47
+ Determines the node name.
48
+
49
+ Defaults:
50
+
51
+ - Journal: `journal`
52
+ - Scratch: `scratch`
53
+
54
+ ### default{NodeType}DateFormat
55
+
56
+ Determines the date format.
57
+
58
+ Defaults:
59
+
60
+ - Journal: `Y-MM-DD`
61
+ - Scratch: `Y-MM-DD-HHmmss`
62
+
63
+ ### default{NodeType}AddBehavior
64
+
65
+ Determines how note is added in relation to current hierarchy. Say you have the following schema:
66
+
67
+ ```yml
68
+ schema:
69
+ - id: pro
70
+ parent: root
71
+ namespace: true
72
+ ```
73
+
74
+ Possible values:
75
+
76
+ - childOfDomain
77
+ - note is added as child of the [domain](https://dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#domain) of the current hierarchy
78
+ - eg:
79
+ - current open note: `pro.dendron.demo.md`
80
+ - path of new journal note: `pro.journal.2020-08-03.md`
81
+ - childOfDomainNamespace
82
+ - note is added as child of the namespace of the current domain if it has a namespace. otherwise behaves the same as `childOfDomain`
83
+ - eg:
84
+ - current open note: `pro.dendron.demo.md`
85
+ - path of new journal note: `pro.dendron.journal.2020-08-03.md`
86
+ - childOfCurrent
87
+ - note is added as a child of the current open note
88
+ - current open note: `pro.dendron.demo.md`
89
+ - path of new journal note: `pro.dendron.demo.journal.2020-08-03.md`
90
+ - asOwnDomain
91
+ - note is created under the domain specified by the `dendron.default{NodeType}Name` config value
92
+ - eg:
93
+ - current open note: `pro.dendron.demo.md`
94
+ - config: `dendron.defaultJournalNoteName: "journal"`
95
+ - path of new journal note: `journal.2020-08-03.md`
96
+
97
+ Defaults:
98
+
99
+ - Journal: `childOfDomain`
100
+ - Scratch: `asOwnDomain`
101
+

Added: vault/dendron.topic.style.md

Files changed (1) hide show
  1. vault/dendron.topic.style.md +16 -0
vault/dendron.topic.style.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ id: 734a8c36-baff-43d1-8b12-99bb16837049
3
+ title: Style
4
+ desc: ''
5
+ updated: 1614542657491
6
+ created: 1606065789770
7
+ nav_exclude: true
8
+ ---
9
+ ## Colors
10
+
11
+ - `#69B160` - **"dendron green"** - eyedropper-picked from logo
12
+
13
+ ## Logo
14
+
15
+ ![logo](/assets/images/logo.png)
16
+

Added: vault/dendron.topic.tags.md

Files changed (1) hide show
  1. vault/dendron.topic.tags.md +33 -0
vault/dendron.topic.tags.md ADDED
@@ -0,0 +1,33 @@
1
+ ---
2
+ id: 8bc9b3f1-8508-4d3a-a2de-be9f12ef1821
3
+ title: Tags
4
+ desc: ''
5
+ updated: 1604239992867
6
+ created: 1601910058115
7
+ stub: false
8
+ ---
9
+ Besides hierarchies, Dendron also supports tags. We recommend that you use the following syntax for tags:
10
+
11
+ ```md
12
+ [[tag.foo]]
13
+ ```
14
+
15
+ You get a few advantages for structuring tags in this format.
16
+
17
+ 1. Your tags are just regular hierarchical notes - to find all notes with a particular tag, use the backlink panel
18
+ 2. All the operations on notes and hierarchies apply to tags (eg. Rename, Refactor, etc) and will update both the note and all links
19
+ 3. You can deeply nest tags by adding additional levels to your hierarchies
20
+ 4. You can use autocomplete to create tags
21
+
22
+ ## Pretty Tags
23
+
24
+ You can format your tags to look like regular tags wiki-link aliases
25
+
26
+ ```md
27
+ [[#foo|tag.foo]] --> will render as #foo
28
+ ```
29
+
30
+ You can further customize the look of tags in the preview by using the following CSS modification.
31
+
32
+ ((ref:[[dendron.guides.tips]]#stylized tags using custom css:#*))
33
+

Added: vault/dendron.topic.workbench.md

Files changed (1) hide show
  1. vault/dendron.topic.workbench.md +84 -0
vault/dendron.topic.workbench.md ADDED
@@ -0,0 +1,84 @@
1
+ ---
2
+ id: f7ebd4aa-8ba7-4bc5-bd00-a1efc5315f07
3
+ title: Workbench
4
+ desc: ''
5
+ updated: 1614312211145
6
+ created: 1595170237255
7
+ stub: false
8
+ ---
9
+ The Dendron workbench is the overall UI that surrounds the editor. It is equivalent to the [VSCode workbench](https://code.visualstudio.com/api/extension-capabilities/extending-workbench).
10
+
11
+ ![workbench](https://code.visualstudio.com/assets/api/extension-capabilities/extending-workbench/workbench-contribution.png)
12
+
13
+ > Image from [Visual Studio Docs](https://code.visualstudio.com/api/extension-capabilities/extending-workbench)
14
+
15
+ Dendron has a few custom workbench components to deal with hierarchal notes.
16
+
17
+ ## Outline View
18
+
19
+ <a href="https://www.loom.com/share/41d1bd75be8e4fa0b0666b6e8f22174b">
20
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/41d1bd75be8e4fa0b0666b6e8f22174b-with-play.gif"> </a>
21
+
22
+ ### Updating Outline
23
+
24
+ The outline can be sorted a variety of ways. You can control this by clicking the three dots on the side.
25
+
26
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__1_24_PM.jpg)
27
+
28
+ ## Dendron Tree View
29
+
30
+ The Dendron Tree View lets you view your hierarchal notes as a traditional folder hierarchy.
31
+
32
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.gif)
33
+
34
+ The Dendron Tree View has the following capabilities:
35
+
36
+ - click to open note
37
+
38
+ - show indicators for `stub` and `schema` notes
39
+
40
+ - show title using tooltip
41
+
42
+ - realtime update when you create/delete notes
43
+
44
+ - toggle all functionality
45
+
46
+ - click to create from stub
47
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.stub.gif)
48
+
49
+ - reveal currently open text document
50
+
51
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview-active-doc.gif)
52
+
53
+ ## Backlinks
54
+
55
+ You can see all notes that are linked to the current note via the backlink panel.
56
+
57
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__7_41_PM.jpg)
58
+
59
+ ## Working with Multiple Columns
60
+
61
+ VSCode lets you create multiple columns of your editor and arrange them any way you want them.
62
+
63
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.windows.gif)
64
+
65
+ ### Expanding the Current Editor
66
+
67
+ You can use the `toggleEditorWidth` command with a hotkey to quickly expand the current editor.
68
+
69
+ ```json
70
+ {
71
+ "command": "workbench.action.toggleEditorWidths",
72
+ "key": "ctrl+cmd+m"
73
+ }
74
+ ```
75
+
76
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.toggle-editor.gif)
77
+
78
+ <!-- TODO
79
+
80
+ ### Zen Mode
81
+
82
+ ### Useful Shortcuts
83
+ -->
84
+

Added: vault/dendron.tutorial.links.md

Files changed (1) hide show
  1. vault/dendron.tutorial.links.md +168 -0
vault/dendron.tutorial.links.md ADDED
@@ -0,0 +1,168 @@
1
+ ---
2
+ id: d758fe38-558c-4f20-a091-cac146a781cb
3
+ title: Working with Links
4
+ desc: ''
5
+ updated: 1614111008359
6
+ created: 1608055731373
7
+ nav_order: 1
8
+ ---
9
+
10
+ ## Summary
11
+
12
+ In this module, we will demonstrate how to use links and backlinks to create connections between your notes.
13
+
14
+ ### Creating a link
15
+
16
+ Lets say that you work at a small IT firm and you want to create onboarding docs for your employees.
17
+
18
+
19
+ Create a new note using lookup called `onboarding`. Then type in the following in the note.
20
+
21
+ ```
22
+ Read up on `[[`
23
+ ```
24
+
25
+ The `[[` tells Dendron that you are about to create a link. Dendron will auto-complete with a matching set of closing brackets `]]` as well as give you a list of completions of existing notes.
26
+
27
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.completion.jpg)
28
+
29
+ We are going to create a new note instead of linking to an existing note. So type `pro.skynet` as your link.
30
+
31
+ ```
32
+ Read up on [[pro.skynet]]
33
+ ```
34
+
35
+ In this case, `pro` is an alias for `projects` and `skynet` is the code name of the project.
36
+
37
+ ### Creating a note (with a link)
38
+
39
+ With your cursor somewhere inside `[[pro.skynet]]`, hit `F12`. This will create the `pro.skynet` note. Just like with lookup, Dendron automatically creates notes to links that don't exist when you navigate to them.
40
+
41
+ You can switch back to the previous note by pressing `CTRL-Tab`
42
+
43
+ - TIP: `F12` is not the most convenient shortcut for this often used action. You can switch it to `CTRL-ENTER` or something more convenient by updating the [[keybindings|dendron.topic.keybindings#add-reset-and-remove]]
44
+
45
+ ### Adding a link alias
46
+
47
+ You can add an alternative title to the link by creating an alias. For example, add `the project|` to your link to change the name in the preview, (If you've closed your preview, you can open it using `CMD+SHIFT+P` or `WINDOWS+SHIFT+P`).
48
+
49
+ ```
50
+ Read up on [[the project|pro.skynet]]
51
+ ```
52
+
53
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.alias.jpg)
54
+
55
+ ### Navigating links
56
+
57
+ To go back to the previous page, you can either use `CTRL-TAB`, hit `F12` over the link, click the link on the preview, or click the link inside the note while holding down the `option` or `ctrl` key (operating system dependent).
58
+
59
+ The takeaway here is that you have lots of ways to navigate links in Dendron.
60
+
61
+ ### Backlinks
62
+
63
+ When your back on `pro.skynet`, open the backlinks panel on the bottom left section of your sidebar. The backlinks panel shows you all notes with links that point to the current note. This is useful for helping to establish context.
64
+
65
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.backlinks.jpg)
66
+
67
+ ### Note References
68
+
69
+ Inside `pro.skynet`, copy and paste the following snippet.
70
+
71
+ ```md
72
+ ## Summary
73
+
74
+ Skynet is a friendly bot to help humans do more
75
+
76
+ ## Principles
77
+ - [[pro.skynet.principals]]
78
+
79
+ ```
80
+
81
+ Navigate to `pro.skynet.principals`. In this new note, write the principles for skynet.
82
+
83
+ ```md
84
+ 1. Help humans do more
85
+ 2. Be nice to humans
86
+ 3. Don't overthrow humanity
87
+ ```
88
+
89
+ While its nice to have principals in its own section, it's something you might want to include in the main project note. To embed a note into another note, Dendron uses [[note references|dendron.topic.refs]]. You can create a note reference by using `CMD|CTRL+SHIFT+R` while inside a note. Go ahead and do that now and use `CTRL-TAB` to switch back to `pro.skynet`. Now paste the reference and remove the original wiki-link.
90
+
91
+ ```md
92
+ ## Summary
93
+
94
+ Skynet is a friendly bot to help humans do more
95
+
96
+ ## Principles
97
+ ![[pro.skynet.principals]]
98
+
99
+ ```
100
+
101
+ You should have a screen like the one below.
102
+
103
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.refs.jpg)
104
+
105
+ ### Note References (continued)
106
+
107
+ Note references are extremely powerful and help you re-use your notes in a variety of places. To demonstrate, go back to the `pro.skynet.principals` and make the following modifications to the text so that each numbered bullet becomes its own header.
108
+
109
+ ```md
110
+ ## Help humans do more
111
+
112
+ Skynet should help humans be the best human they can be. Skynet will do this using ultrasophisticated AI to help humans realize their true potential.
113
+
114
+ ## Be nice to humans
115
+
116
+ Skynet should know that humans are delicate organic lifeforms and treat them as such. Skynet should not hurt their fragile egos or make humans feel bad.
117
+
118
+ ## Don't overthrow humanity
119
+
120
+ Skynet should not launch nuclear missles or send robots from the future to come back to the past and wipe out humanity.
121
+ ```
122
+
123
+ Now highlight the first header and use `CMD|CTRL+SHIFT+R` to create another note reference.
124
+
125
+ Go back to `pro.skynet`. Notice how the note ref has updated with the latest text.
126
+
127
+ Now copy your newly created reference and paste it underneath.
128
+ - notice that the newly created reference only has the contents from the newly created header
129
+ - notice that the newly created reference doesn't show the actual header itself (you can change this behavior by removing the `,1` inside the reference)
130
+
131
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/c62f82859545444a9786abaa36426b62" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
132
+
133
+
134
+ Note references are incredibly powerful. You can do additional things like enter a range of headers to do a reference of, include a reference within a reference, and even reference multiple pages using a wildcard pattern. You can see detailed examples of all these functions in the [[docs|dendron.topic.refs]].
135
+
136
+ ### Relative Links
137
+
138
+ Sometimes, you don't want to embed a note but just link to a particular section of a given note. You can do that with Dendron relative links. The syntax to do so is `[[{link-name}#{link-header}]]`. Dendron will create a relative link automatically if you select the header and use `CMD|CTRL+SHIFT+C` to create a link (if you don't have a header selected, Dendron will create a regular link to the whole page). When you navigate to a regular link, Dendron will scroll to that specific section of the page.
139
+
140
+ ### Link Previews
141
+
142
+ Something to point out is that you can preview a link by using your mouse to hover over it. This even works for note references.
143
+
144
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.links-preview.jpg)
145
+
146
+ ### Non-Markdown Links
147
+
148
+ ![[dendron.topic.links#other-links,1]]
149
+
150
+ ### Files
151
+
152
+ At the end of this module, you should have the following files in your vault
153
+
154
+ ```
155
+ .
156
+ └── vault
157
+ ├── dendron.md
158
+ ├── dendron.welcome.md
159
+ ├── hello.md
160
+ ├── hello.world.md
161
+ ├── lets.go.deep.md
162
+ ├── onboarding.md
163
+ ├── pro.skynet.md
164
+ └── pro.skynet.principals.md
165
+ ```
166
+
167
+ ### Next
168
+ - [[Publishing your notes|dendron.tutorial.publishing]]

Added: vault/dendron.tutorial.md

Files changed (1) hide show
  1. vault/dendron.tutorial.md +18 -0
vault/dendron.tutorial.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ id: 678c77d9-ef2c-4537-97b5-64556d6337f1
3
+ title: Dendron Tutorial
4
+ desc: ''
5
+ updated: 1614118652781
6
+ created: 1608051264282
7
+ nav_order: 1.1
8
+ ---
9
+ ## Pre-requisites
10
+
11
+ This walkthrough will help you get started with Dendron. Before you start, make sure you have Dendron installed. If not, you can do so by following the instructions [[here|dendron.guides.install]].
12
+
13
+ ### Your first workspace
14
+
15
+ After you've started Dendron, you should see a screen like the one below (depending on your color theme, your color theme might look different).
16
+
17
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.workspace.jpg)
18
+

Added: vault/dendron.tutorial.notes.md

Files changed (1) hide show
  1. vault/dendron.tutorial.notes.md +70 -0
vault/dendron.tutorial.notes.md ADDED
@@ -0,0 +1,70 @@
1
+ ---
2
+ id: 784b8d5e-58eb-4e3e-98b0-8ed1690abc74
3
+ title: Working with Notes
4
+ desc: ''
5
+ updated: 1614109519084
6
+ created: 1608055635963
7
+ nav_order: 0
8
+ ---
9
+
10
+ ## Summary
11
+
12
+ In this module, we will demonstrate how to create and find notes inside Dendron.
13
+
14
+ ### Creating your first note
15
+
16
+ To create a note, `<cmd>+L` (mac) or `<ctrl>+L` (windows/linux) to bring up Dendron's [[lookup|dendron.topic.lookup]].
17
+
18
+ ![[dendron.topic.lookup.create#summary,1:#*]]
19
+
20
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.hello.png)
21
+
22
+ Note that notes in Dendron are just plaintext [[markdown|dendron.concepts#markdown]]. They live in your file system and are completely portable across any platform.
23
+
24
+ The `---` section at the top is [[frontmatter|dendron.concepts#frontmatter]]. Frontmatter are custom attributes at the top of each markdown file. Dendron uses it to store metadata about each note and is used for features like [[publishing|dendron.topic.publishing]]. You can also add your own custom data to the frontmatter.
25
+
26
+ ### Creating a hierarchy
27
+
28
+ To create a hierarchy, bring up lookup again. Note that it will be pre-filled with the name of the current note.
29
+
30
+ Enter ➡️ to move the cursor to the end, type `.world`, and then press enter.
31
+
32
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.hello-world.jpg)
33
+
34
+ You have now created your first [[hierarchy|dendron.concepts#hierarchies]].
35
+
36
+ Hierarchy in dendron are just `.` delimited files. You can open the tree view (exhibit 1) to see the hierarchy more directly. You can see how the note looks on disk in the explorer view (exhibit 2).
37
+
38
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.tree-view.jpg)
39
+
40
+ Dendron uses (flexible) hierarchies to help you organize your notes. It's how people are able to manage tens of thousands of notes inside Dendron. This will become more clear as we go through this tutorial.
41
+
42
+ Note that you can create a hierarchy at any level without friction. For example, type the following into lookup and hit enter: `lets.go.deep`
43
+
44
+ You'll notice in the tree view that there is now a `+` sign next to `lets` and `go`. The plus sign indicates that this note is a [[stub|dendron.concepts#stubs]]. A stub is a placeholder for a note that hasn't actually been created. Dendron uses stubs to avoid cluttering your file system with empty notes when creating hierarchies.
45
+
46
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.deep.jpg)
47
+
48
+ ### Finding Notes
49
+
50
+ To find notes, we use the same lookup interface that we used to create them. Type the path of the note that you want to find them. Note that lookup uses fuzzy search which means you can type out partial results and still see the results. In practice, you'll only need to type a couple of characters to find any note stored inside Dendron.
51
+
52
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.lookup-fuzzy.jpg)
53
+
54
+
55
+ ### Files
56
+
57
+ At the end of this module, you should have the following files in your vault
58
+
59
+ ```
60
+ .
61
+ └── vault
62
+ ├── dendron.md
63
+ ├── dendron.welcome.md
64
+ ├── hello.md
65
+ ├── hello.world.md
66
+ └── lets.go.deep.md
67
+ ```
68
+
69
+ ### Next
70
+ - [[Working with Links|dendron.tutorial.links]]

Added: vault/dendron.tutorial.publishing.md

vault/dendron.tutorial.publishing.md ADDED
@@ -0,0 +1,55 @@
1
+ ---
2
+ id: 9c6f600e-f1f3-423b-963a-c71bb081334c
3
+ title: Working with Publishing
4
+ desc: ''
5
+ updated: 1614201760918
6
+ created: 1614108618486
7
+ ---
8
+ ## Summary
9
+
10
+ In this module, we'll learn how to publish your notes using Dendron's Managed Publishing.
11
+
12
+ You can read about dendron's publishing features [[here|dendron.topic.publishing]].
13
+
14
+ You can see the repo with the published results [here](https://github.com/kevinslin/tutorial-ws).
15
+
16
+ ### Previewing your notes
17
+
18
+ 1. Run `Site: Preview` to launch the site preview
19
+
20
+ - The first time you run this, you will need to install the required dependencies. Hit install to do so
21
+ ![Install dependencies](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.site-preview.jpg)
22
+ - when dependencies are done installing, Dendron will automatically open up a browser with a preview of your published notes (if this is the first time you've run this, VSCode will ask you for permission to open the link)
23
+
24
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/42d2042241964dd29c03a6fc985b3ebc" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
25
+
26
+ ### Commit your notes
27
+
28
+ After you have previewed your notes, you're ready to publish. Dendron publishes notes using github. First, start by committing all your notes to git.
29
+
30
+ > Create Integrated Terminal
31
+
32
+ ```
33
+ git init
34
+ git add .
35
+ git commit -m "..."
36
+ ```
37
+
38
+ ### Create a github repo
39
+
40
+ If you don't already have an account, create a [github](https://github.com/) account. Afterwards create a new repository by clicking [here](https://github.com/new).
41
+
42
+ You can title your repository `tutorial-ws`. After Clicking create, you should be taken to the following page.
43
+
44
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendronhq_tutorial-ws.jpg)
45
+
46
+ Copy the text from `push an existing repository` section and run it in the terminal to sync your content with github.
47
+
48
+ ### Publish your github repo
49
+
50
+ ![[dendron.topic.managed-publishing.quickstart#instructions,1:#*]]
51
+
52
+ Your published site will be available at `https://{username}.dendron.wiki`
53
+
54
+ You can see an example of what this looks like at <https://hello.dendron.wiki>
55
+

Added: vault/dendron.welcome.md

Files changed (1) hide show
  1. vault/dendron.welcome.md +37 -0
vault/dendron.welcome.md ADDED
@@ -0,0 +1,37 @@
1
+ ---
2
+ id: 05774b2e-ebf7-4bbc-8171-ad191ba0ae0a
3
+ title: "Welcome to Dendron \U0001F332"
4
+ desc: ''
5
+ updated: 1608485512294
6
+ created: 1598457956604
7
+ stub: false
8
+ nav_exclude: true
9
+ ---
10
+ ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)
11
+
12
+ Dendron is a new approach to note taking, one that combines the freedom of Roam's _every note exists everywhere philosophy_ with the organization provided by _flexible hierarchies_.
13
+
14
+ We call this the [hierarchy first approach](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html) to note taking.
15
+
16
+ ## What is a Dendron?
17
+
18
+ 1. Dendron is the greek word for tree. It's a reference to the hierarchal note taking that Dendron(3) enables.
19
+ 2. Dendron is another word for [dendrite](https://en.wikipedia.org/wiki/Dendrite) which is an extension of the nerve cell that sends and receives signals in the brain. Think of Dendron(3) as a digital nervous system that helps you consolidate all the information that you care about in the fastest and most efficient way possible.
20
+ 3. Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you build, organize, and share knowledge bases of any size.
21
+
22
+ ## How do I get started?
23
+
24
+ 1. Launch the _command bar_ inside vscode:
25
+ - Linux: `Ctrl+Shift+P`
26
+ - macOS: `Cmd+Shift+P`
27
+ - Windows: `Ctrl+Shift+P`
28
+ 2. Paste the following command and press `Enter`:
29
+
30
+ ```bash
31
+ > Dendron: Initialize Workspace
32
+ ```
33
+
34
+ ![Initialize workspace](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/dendron-init.gif)
35
+
36
+ When the workspace opens, it will show dialogue to install the recommended extensions. Though not required, these extensions add all the **non-core** features of Dendron like wiki links and tagging support.
37
+

Added: vault/dendron.workflows.academics.md

vault/dendron.workflows.academics.md ADDED
@@ -0,0 +1,24 @@
1
+ ---
2
+ id: 77c8f69c-32b8-4331-b1b2-c4211dcb9fb7
3
+ title: Academics
4
+ desc: ''
5
+ updated: 1600207322349
6
+ created: 1600207322349
7
+ stub: false
8
+ ---
9
+ - NOTE: this guide is a work in progress
10
+
11
+ You can use a combination of external links and footnotes to keep track of papers you are reading.
12
+
13
+ ((ref:[[dendron.topic.markdown]]#footnotes,1:#*))
14
+
15
+ If you move links inside Dendron's `vault/assets` folder, you'll be able to keep your papers in sync across devices.
16
+
17
+ ((ref:[[dendron.topic.links]]#other links,1))
18
+
19
+ ## Citations
20
+
21
+ - The following extensions help you generate citations
22
+ - <https://marketplace.visualstudio.com/items?itemName=notZaki.pandocciter>
23
+ - <https://marketplace.visualstudio.com/items?itemName=mblode.zotero>
24
+

Added: vault/dendron.workflows.amoeba.md

Files changed (1) hide show
  1. vault/dendron.workflows.amoeba.md +17 -0
vault/dendron.workflows.amoeba.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ id: e780000d-c784-4945-8e42-35218a3ecf10
3
+ title: Amoeba
4
+ desc: ''
5
+ updated: 1600729134898
6
+ created: 1600729134898
7
+ stub: false
8
+ ---
9
+ The amoeba pattern is way of creating notes and schemas using an iterative process.
10
+
11
+ It helps answer the question - "how do I organize my notes in Dendron when I don't know the topic/hierarchy ahead of time"?
12
+
13
+ In a nutshell, the Amoeba pattern says to lump everything into a single note until it becomes obvious what the potential groupings might be. Dendron provides a bunch of features (eg. extract note via selection, hierarchy refactoring, schemas, hierarchal graphs) that make it easy to do this. You can see an example of this workflow in action here.
14
+
15
+ <a href="https://www.loom.com/share/847bee04870744979bd32d1a7f0e166a">
16
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/847bee04870744979bd32d1a7f0e166a-with-play.gif"> </a>
17
+

Added: vault/dendron.workflows.bullet-journal.md

vault/dendron.workflows.bullet-journal.md ADDED
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: e65dfe53-41f7-4b16-b870-dadec1775497
3
+ title: Bullet Journaling
4
+ desc: ''
5
+ updated: 1604764944798
6
+ created: 1601684760121
7
+ stub: false
8
+ ---
9
+ Bullet journalling is a way of quickly getting your thoughts down for the day. In many ways, its more akin to a GTD and task management than traditional journalism.
10
+
11
+ ## Kevin's Workflow
12
+
13
+ <a href="https://www.loom.com/share/d710f69972f8418eb0fdb029e19c3b02">
14
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/d710f69972f8418eb0fdb029e19c3b02-with-play.gif"> </a>
15
+
16
+ ## Features Used
17
+
18
+ ### Create Daily Journal Notes Command
19
+
20
+ ((ref:[[dendron.topic.special-notes]]#daily journal,1:#*))
21
+
22
+ ### Sibling Navigation Command
23
+
24
+ ((ref:[[dendron.topic.commands]]#go next sibling,1:#*))
25
+
26
+ ### Schema Templates
27
+
28
+ ((ref:[[dendron.topic.schema]]#template,1:#*))
29
+
30
+ ## VSCode Commands
31
+
32
+ ### Move Editor Command
33
+
34
+ ((ref:[[dendron.guides.tips]]#moving panes,1))
35
+
36
+ ## Kevin's Workflow Part 2
37
+
38
+ By popular demand, here's an expanded take on how Kevin uses journals in Dendron
39
+
40
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/e544f84381784a2188a57dc657f72017" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
41
+

Added: vault/dendron.workflows.cache.md

Files changed (1) hide show
  1. vault/dendron.workflows.cache.md +39 -0
vault/dendron.workflows.cache.md ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ id: 3e7baac6-f120-4378-a667-92e7a0869dca
3
+ title: Caching
4
+ desc: ''
5
+ updated: 1604887085455
6
+ created: 1599842689882
7
+ stub: false
8
+ ---
9
+ One use of a knowledge base is that of a [cache](https://en.wikipedia.org/wiki/Cache_(computing)) - quickly referencing information you have seen or worked with before.
10
+
11
+ The most important properties of an effective cache:
12
+
13
+ - fast referencing (of an existing note)
14
+ - fast writing (of a new note)
15
+ - fast updating (of existing notes)
16
+
17
+ Dendron is ideally suited for this knowledge-as-a-cache use case.
18
+
19
+ - [[Dendron lookups|dendron.topic.lookup]] provide fast reading/writing of both new and existing notes
20
+ - [[Dendron schemas|dendron.topic.schema]] help structure your knowledge even as you accumulate more notes
21
+
22
+ ## Example
23
+
24
+ You can see a public example of what this might look like on [Kevin's project reference hierarchy](https://www.kevinslin.com/notes/f46d3d6c-9704-4ddc-ad7d-69612d214905.html). He keeps public reference notes on projects he's used.
25
+
26
+ Some things to note:
27
+
28
+ - when using your notes as a cache, you might have duplicate content from other sites. be aware of copyright laws and check that you can re-publish said content
29
+ - when re-publishing content, google will penalize your site if you have duplicate content from other sites. you can tell google to not index specific pages or hierarchies
30
+
31
+
32
+ ## Exclude page from index
33
+
34
+ ((ref:[[dendron.topic.publishing.advanced]]#exclude from indexing,1:#*))
35
+
36
+ ## Exclude hierarchy from index
37
+
38
+ - set [[noindexByDefault|dendron.topic.publishing]] to true in your site hierarchy specific config
39
+

Added: vault/dendron.workflows.collab.md

Files changed (1) hide show
  1. vault/dendron.workflows.collab.md +30 -0
vault/dendron.workflows.collab.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: 058d298a-1b1e-4340-8ebd-7dbcc5a6f119
3
+ title: Collab
4
+ desc: ''
5
+ updated: 1599751228313
6
+ created: 1599751228313
7
+ stub: false
8
+ ---
9
+ Because knowledge is like kit kat - it's better shared.
10
+
11
+ ## Git/Github
12
+
13
+ Git and github, while traditionally used for collaborating on code, works out great for notes as well.
14
+
15
+ ### Git
16
+
17
+ - use `git blame` to see line level authorship of all your notes
18
+ - use the git feature branch workflow to have multiple people working on separate parts of the knowledge base at the same time
19
+
20
+ ### Github
21
+
22
+ - use pull requests to contribute and collection contributions for your notes
23
+ - use the wiki to have meta discussions about notes
24
+ - use issues to request changes
25
+ - use github projects to share publishing roadmap
26
+
27
+ ## Live Share
28
+
29
+ VSCode provides a live share extension that let you do google doc style like collab. You can the extension and read the docs about it [here](https://visualstudio.microsoft.com/services/live-share/).
30
+

Added: vault/dendron.workflows.md

Files changed (1) hide show
  1. vault/dendron.workflows.md +11 -0
vault/dendron.workflows.md ADDED
@@ -0,0 +1,11 @@
1
+ ---
2
+ id: 9313b845-d9bf-42c9-aad1-0da34794ce26
3
+ title: Workflows
4
+ desc: ''
5
+ updated: 1599059343888
6
+ created: 1599059343888
7
+ stub: false
8
+ nav_order: 4.6
9
+ ---
10
+ Different ways of using Dendron to accomplish specific goals
11
+

Added: vault/dendron.workflows.meetings.md

Files changed (1) hide show
  1. vault/dendron.workflows.meetings.md +44 -0
vault/dendron.workflows.meetings.md ADDED
@@ -0,0 +1,44 @@
1
+ ---
2
+ id: cebe5393-5da0-484c-a24a-0939f0cef768
3
+ title: Meeting Notes
4
+ desc: ''
5
+ updated: 1599059373505
6
+ created: 1599059373505
7
+ stub: false
8
+ ---
9
+ This is a video of keeping meeting notes in Dendron. Meeting notes are kept as **journal notes** on a per-project basis.
10
+
11
+ <a href="https://www.loom.com/share/c04dd4b3c82a412b82b1f9f75e2291bd"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c04dd4b3c82a412b82b1f9f75e2291bd-with-play.gif"> </a>
12
+
13
+ ## Resources
14
+
15
+ Settings and files used for the above video.
16
+
17
+ - project schema
18
+
19
+ ```yml
20
+ - id: pro
21
+ title: pro
22
+ desc: ""
23
+ parent: root
24
+ namespace: true
25
+ children:
26
+ - people
27
+ - meet
28
+ - todo
29
+ - retrospective
30
+ - id: people
31
+ - id: meet
32
+ - id: todo
33
+ - id: retrospective
34
+ ```
35
+
36
+ - journal specific settings
37
+
38
+ ```json
39
+ {
40
+ "dendron.defaultJournalAddBehavior": "childOfDomainNamespace",
41
+ "dendron.defaultJournalDateFormat": "Y.MM.DD",
42
+ }
43
+ ```
44
+

Added: vault/dendron.workflows.scripts.md

Files changed (1) hide show
  1. vault/dendron.workflows.scripts.md +37 -0
vault/dendron.workflows.scripts.md ADDED
@@ -0,0 +1,37 @@
1
+ ---
2
+ id: 8514245e-6405-4759-8dda-ab77cf173075
3
+ title: Scripts
4
+ desc: ''
5
+ updated: 1600964220962
6
+ created: 1600964220962
7
+ stub: false
8
+ ---
9
+ ## Problem Statement
10
+
11
+ You have scripts that you want to organize and whose outputs you might want to render using Dendron.
12
+
13
+ ## Solution
14
+
15
+ Currently (2020.09.24), Dendron's convention for any file that is not markdown is to keep it under an assets folder in your vault.
16
+
17
+ ```
18
+ .
19
+ └── workspace
20
+ └── vault
21
+ ├── root.md
22
+ ├── ...
23
+ └── assets
24
+ ├── images/
25
+ └── scripts/
26
+ ```
27
+
28
+ For example, images are saved under `assets/images/` and referenced as `/assets/images/*` inside your notes.
29
+
30
+ You can do the same with scripts by keeping them under a `scripts` directory.
31
+
32
+ You can navigate to them via regular vscode `(cmd|ctrl+p)`, and then include them as code chunks in your markdown.
33
+
34
+ The dendron preview accepts running code chunks. You can see the instructions [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk)
35
+
36
+ Vscode is also adding native support for notebooks so as that support becomes more mature, we'll probably look into making this process less kludgy.
37
+

Added: vault/dendron.workflows.todos.md

Files changed (1) hide show
  1. vault/dendron.workflows.todos.md +118 -0
vault/dendron.workflows.todos.md ADDED
@@ -0,0 +1,118 @@
1
+ ---
2
+ id: 593206ea-5658-4874-bafd-18a138870f91
3
+ title: Todos
4
+ desc: ''
5
+ updated: 1604239992242
6
+ created: 1596566533712
7
+ stub: false
8
+ ---
9
+ ## Snippets
10
+
11
+ The default dendron workspace comes with the `to` snippet that expands to `- [ ]`. You can use this to quickly create bulleted checkboxes.
12
+
13
+ ## Interactive Checkboxes
14
+
15
+ Markdown preview renders an empty checkbox for any line that starts with `- [ ]`. A checked checkbox is rendered for lines starting with `- [x]`. Clicking a checkbox changes its state in the markdown file.
16
+
17
+ ## General Workflows
18
+
19
+ When working with todos sometimes you need more states than `unfinished|finished`. Below are three different workflows to delineate todo state.
20
+
21
+ ### Inside the Checkbox
22
+
23
+ - put state in checkbox
24
+ - note that custom checkbox states such as `[w]` are displayed as plain text in markdown previews. Todo lists of this type look best in the editor.
25
+
26
+ ```
27
+ - [ ] : not started
28
+ - [w] : work in progress
29
+ - [x] : done
30
+ - [?] : feedback
31
+ - [>] : postponed
32
+ ```
33
+
34
+ ### Kanban Based
35
+
36
+ - put state in a header
37
+
38
+ ```
39
+ # wip
40
+ - [ ] foo
41
+
42
+ # pending
43
+ - [ ] bar
44
+
45
+ # done
46
+ - [ ] baz
47
+ ```
48
+
49
+ ### Tag Based
50
+
51
+ - put tags in todo items
52
+
53
+ ```
54
+ - [ ] foo #wip
55
+ - [ ] bar #feedback
56
+ - [ ] baz
57
+ ```
58
+
59
+ ## Reordering tasks
60
+
61
+ ((ref:[[dendron.guides.tips]]#Moving lines,1:#*))
62
+
63
+ ## Kevin's Workflow
64
+
65
+ This is a video of how Kevin manages todos in Dendron. It goes over the following:
66
+
67
+ - using [[journal notes|dendron.topic.special-notes]] to keep a daily todo list
68
+ - using [[snippets|dendron.topic.snippets]] to create check boxes
69
+ - using [[scratch notes|dendron.topic.special-notes]] to create nested todos in new notes
70
+ - using [search editor commands](https://code.visualstudio.com/updates/v1_47#_new-search-editor-command-arguments) to get an aggregration of all tasks in a given day
71
+
72
+ <a href="https://www.loom.com/share/88cfdc3e900a4f4eadf7b14429e01d65">
73
+ <img style="" src="https://cdn.loom.com/sessions/thumbnails/88cfdc3e900a4f4eadf7b14429e01d65-with-play.gif">
74
+ </a>
75
+
76
+ ### Resources
77
+
78
+ Below are some of the settings used in the above video
79
+
80
+ - non-default settings
81
+
82
+ ```json
83
+ "settings": {
84
+ "dendron.defaultJournalDateFormat": "Y.MM.DD",
85
+ "dendron.defaultScratchDateFormat": "Y.MM.DD-HHmmss",
86
+ }
87
+ ```
88
+
89
+ - snippets used
90
+
91
+ ```json
92
+ "todo": {
93
+ "prefix": "to",
94
+ "scope": "markdown",
95
+ "body": "- [ ] ",
96
+ "description": "todo box"
97
+ }
98
+ ```
99
+
100
+ - search editor command used
101
+
102
+ ```json
103
+ {
104
+ "key": "ctrl+s t",
105
+ "command": "search.action.openNewEditor",
106
+ "args": {
107
+ "query": "## Tasks",
108
+ "triggerSearch": false,
109
+ "focusResults": false,
110
+ "includes": "*.journal.*"
111
+ }
112
+ }
113
+ ```
114
+
115
+ ## Other Resources
116
+
117
+ - [Markdown Checkbox Extension](https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox): automatically check todos
118
+